OIDCAuthProviderConfig interface

ממשק התצורה של ספק האימות [OIDC](https://openid.net/specs/openid-connect-core-1_0-final.html). ניתן ליצור ספק OIDC באמצעות BaseAuth.createProviderConfig() .

חֲתִימָה:

export interface OIDCAuthProviderConfig extends BaseAuthProviderConfig

מורחבת: BaseAuthProviderConfig

נכסים

תכונה סוּג תיאור
זיהוי לקוח חוּט זהו מזהה הלקוח הנדרש המשמש לאישור הקהל של [אסימון הזיהוי] של ספק OIDC (https://openid.net/specs/openid-connect-core-1_0-final.html#IDToken).
סוד הלקוח חוּט סוד הלקוח של ספק OIDC כדי לאפשר זרימת קוד OIDC.
מנפיק חוּט זהו מנפיק הספק הנדרש המשמש כדי להתאים למנפיק הספק של אסימון הזיהוי ולקביעת מסמך גילוי ה-OIDC המתאים, למשל. [ /.well-known/openid-configuration ](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig). זה נחוץ עבור הדברים הבאים:
  • כדי לאמת את המנפיק שסופק.
  • קבע את נקודת הקצה של האימות/הרשאה במהלך זרימת האימות של OAuth id_token .
  • כדי לאחזר את מפתחות החתימה הציבוריים דרך jwks_uri כדי לאמת את החתימה של אסימון הזיהוי של ספק ה-OIDC.
  • כדי לקבוע את הטענות_נתמכות לבניית תכונות המשתמש שיוחזרו בתגובת פרטי המשתמש הנוסף.
אימות אסימון מזהה יתבצע כפי שהוגדר ב[מפרט](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation).
responseType OAuthResponseType אובייקט התגובה של ספק OIDC עבור זרימת הרשאות OAuth.

OIDCAuthProviderConfig.clientId

זהו מזהה הלקוח הנדרש המשמש לאישור הקהל של [אסימון הזיהוי] של ספק OIDC (https://openid.net/specs/openid-connect-core-1_0-final.html#IDToken).

חֲתִימָה:

clientId: string;

OIDCAuthProviderConfig.clientSecret

סוד הלקוח של ספק OIDC כדי לאפשר זרימת קוד OIDC.

חֲתִימָה:

clientSecret?: string;

OIDCAuthProviderConfig.issuer

זהו מנפיק הספק הנדרש המשמש כדי להתאים למנפיק הספק של אסימון הזיהוי ולקביעת מסמך גילוי ה-OIDC המתאים, למשל. [ /.well-known/openid-configuration ](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig). זה נחוץ עבור הדברים הבאים:

  • כדי לאמת את המנפיק שסופק.
  • קבע את נקודת הקצה של האימות/הרשאה במהלך זרימת האימות של OAuth id_token .
  • כדי לאחזר את מפתחות החתימה הציבוריים דרך jwks_uri כדי לאמת את החתימה של אסימון הזיהוי של ספק ה-OIDC.
  • כדי לקבוע את הטענות_נתמכות לבניית תכונות המשתמש שיוחזרו בתגובת פרטי המשתמש הנוסף.
אימות אסימון מזהה יתבצע כפי שהוגדר ב[מפרט](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation).

חֲתִימָה:

issuer: string;

OIDCAuthProviderConfig.responseType

אובייקט התגובה של ספק OIDC עבור זרימת הרשאות OAuth.

חֲתִימָה:

responseType?: OAuthResponseType;