OIDCAuthProviderConfig interface

Die [OIDC](https://openid.net/specs/openid-connect-core-1_0-final.html) Auth-Provider-Konfigurationsschnittstelle. Ein OIDC-Anbieter kann über BaseAuth.createProviderConfig() erstellt werden. .

Unterschrift:

export interface OIDCAuthProviderConfig extends BaseAuthProviderConfig

Erweitert: BaseAuthProviderConfig

Eigenschaften

Eigentum Typ Beschreibung
Kunden ID Zeichenfolge Dies ist die erforderliche Client-ID, die zur Bestätigung der Zielgruppe des [ID-Tokens] eines OIDC-Anbieters verwendet wird (https://openid.net/specs/openid-connect-core-1_0-final.html#IDToken).
clientSecret Zeichenfolge Das Client-Geheimnis des OIDC-Anbieters zum Aktivieren des OIDC-Codeflusses.
Aussteller Zeichenfolge Dies ist der erforderliche Anbieter-Aussteller, der zum Abgleichen des Anbieter-Ausstellers des ID-Tokens und zur Ermittlung des entsprechenden OIDC-Erkennungsdokuments verwendet wird, z. [ /.well-known/openid-configuration ](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig). Dies wird für Folgendes benötigt:
  • Zur Überprüfung des angegebenen Emittenten.
  • Bestimmen Sie den Authentifizierungs-/Autorisierungsendpunkt während des OAuth id_token Authentifizierungsablaufs.
  • Zum Abrufen der öffentlichen Signaturschlüssel über jwks_uri , um die Signatur des ID-Tokens des OIDC-Anbieters zu überprüfen.
  • Zur Bestimmung von „claims_supported“, um die Benutzerattribute zu erstellen, die in der zusätzlichen Benutzerinformationsantwort zurückgegeben werden sollen.
Die ID-Token-Validierung wird wie in der [Spezifikation](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation) definiert durchgeführt.
Antworttyp OAuthResponseType Das Antwortobjekt des OIDC-Anbieters für den OAuth-Autorisierungsfluss.

OIDCAuthProviderConfig.clientId

Dies ist die erforderliche Client-ID, die zur Bestätigung der Zielgruppe des [ID-Tokens] eines OIDC-Anbieters verwendet wird (https://openid.net/specs/openid-connect-core-1_0-final.html#IDToken).

Unterschrift:

clientId: string;

OIDCAuthProviderConfig.clientSecret

Das Client-Geheimnis des OIDC-Anbieters zum Aktivieren des OIDC-Codeflusses.

Unterschrift:

clientSecret?: string;

OIDCAuthProviderConfig.issuer

Dies ist der erforderliche Anbieter-Aussteller, der zum Abgleichen des Anbieter-Ausstellers des ID-Tokens und zur Ermittlung des entsprechenden OIDC-Erkennungsdokuments verwendet wird, z. [ /.well-known/openid-configuration ](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig). Dies wird für Folgendes benötigt:

  • Zur Überprüfung des angegebenen Emittenten.
  • Bestimmen Sie den Authentifizierungs-/Autorisierungsendpunkt während des OAuth id_token Authentifizierungsablaufs.
  • Zum Abrufen der öffentlichen Signaturschlüssel über jwks_uri , um die Signatur des ID-Tokens des OIDC-Anbieters zu überprüfen.
  • Zur Bestimmung von „claims_supported“, um die Benutzerattribute zu erstellen, die in der zusätzlichen Benutzerinformationsantwort zurückgegeben werden sollen.
Die ID-Token-Validierung wird wie in der [Spezifikation](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation) definiert durchgeführt.

Unterschrift:

issuer: string;

OIDCAuthProviderConfig.responseType

Das Antwortobjekt des OIDC-Anbieters für den OAuth-Autorisierungsablauf.

Unterschrift:

responseType?: OAuthResponseType;