OIDCAuthProviderConfig interface

อินเทอร์เฟซการกำหนดค่าผู้ให้บริการการตรวจสอบสิทธิ์ [OIDC](https://openid.net/specs/openid-connect-core-1_0-final.html) คุณสามารถสร้างผู้ให้บริการ OIDC ได้ผ่าน BaseAuth.createProviderConfig() .

ลายเซ็น:

export interface OIDCAuthProviderConfig extends BaseAuthProviderConfig

ขยาย: BaseAuthProviderConfig

คุณสมบัติ

คุณสมบัติ พิมพ์ คำอธิบาย
รหัสลูกค้า เชือก นี่คือรหัสไคลเอ็นต์ที่จำเป็นซึ่งใช้ในการยืนยันผู้ชมของ [โทเค็น ID](https://openid.net/specs/openid-connect-core-1_0-final.html#IDToken) ของผู้ให้บริการ OIDC
ความลับของลูกค้า เชือก ข้อมูลลับไคลเอ็นต์ของผู้ให้บริการ OIDC เพื่อเปิดใช้โฟลว์โค้ด OIDC
ผู้ออก เชือก นี่คือผู้ออกผู้ให้บริการที่จำเป็นซึ่งใช้เพื่อจับคู่ผู้ออกโทเค็น ID ของผู้ให้บริการ และเพื่อกำหนดเอกสารการค้นพบ OIDC ที่เกี่ยวข้อง เช่น [ /.well-known/openid-configuration ](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig) สิ่งนี้จำเป็นสำหรับสิ่งต่อไปนี้:
  • เพื่อตรวจสอบผู้ออกที่ระบุ
  • กำหนดจุดสิ้นสุดการตรวจสอบสิทธิ์/การให้สิทธิ์ในระหว่างขั้นตอนการตรวจสอบสิทธิ์ OAuth id_token
  • เพื่อดึงคีย์การลงนามสาธารณะผ่าน jwks_uri เพื่อตรวจสอบลายเซ็นของโทเค็น ID ของผู้ให้บริการ OIDC
  • เพื่อกำหนดการclaim_supportedเพื่อสร้างแอตทริบิวต์ผู้ใช้ที่จะส่งคืนในการตอบกลับข้อมูลผู้ใช้เพิ่มเติม
การตรวจสอบโทเค็น ID จะดำเนินการตามที่กำหนดไว้ใน [spec](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation)
ประเภทการตอบสนอง OAuthResponseType ออบเจ็กต์การตอบสนองของผู้ให้บริการ OIDC สำหรับขั้นตอนการให้สิทธิ์ OAuth

OIDCAuthProviderConfig.clientId

นี่คือรหัสไคลเอ็นต์ที่จำเป็นซึ่งใช้ในการยืนยันผู้ชมของ [โทเค็น ID](https://openid.net/specs/openid-connect-core-1_0-final.html#IDToken) ของผู้ให้บริการ OIDC

ลายเซ็น:

clientId: string;

OIDCAuthProviderConfig.clientSecret

ข้อมูลลับไคลเอ็นต์ของผู้ให้บริการ OIDC เพื่อเปิดใช้โฟลว์โค้ด OIDC

ลายเซ็น:

clientSecret?: string;

OIDCAuthProviderConfig.issuer

นี่คือผู้ออกผู้ให้บริการที่จำเป็นซึ่งใช้เพื่อจับคู่ผู้ออกโทเค็น ID ของผู้ให้บริการ และเพื่อกำหนดเอกสารการค้นพบ OIDC ที่เกี่ยวข้อง เช่น [ /.well-known/openid-configuration ](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig) สิ่งนี้จำเป็นสำหรับสิ่งต่อไปนี้:

  • เพื่อตรวจสอบผู้ออกที่ระบุ
  • กำหนดจุดสิ้นสุดการตรวจสอบสิทธิ์/การให้สิทธิ์ในระหว่างขั้นตอนการตรวจสอบสิทธิ์ OAuth id_token
  • เพื่อดึงคีย์การลงนามสาธารณะผ่าน jwks_uri เพื่อตรวจสอบลายเซ็นของโทเค็น ID ของผู้ให้บริการ OIDC
  • เพื่อกำหนดการclaim_supportedเพื่อสร้างแอตทริบิวต์ผู้ใช้ที่จะส่งคืนในการตอบกลับข้อมูลผู้ใช้เพิ่มเติม
การตรวจสอบโทเค็น ID จะดำเนินการตามที่กำหนดไว้ใน [spec](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation)

ลายเซ็น:

issuer: string;

OIDCAuthProviderConfig.responseType

ออบเจ็กต์การตอบสนองของผู้ให้บริการ OIDC สำหรับขั้นตอนการให้สิทธิ์ OAuth

ลายเซ็น:

responseType?: OAuthResponseType;