REST Resource: projects.oauthIdpConfigs

Ressource: OAuthIdpConfig

Konfigurationsoptionen für die Authentifizierung mit einem OAuth-IdP.

JSON-Darstellung 
{
  "name": string,
  "clientId": string,
  "issuer": string,
  "displayName": string,
  "enabled": boolean,
  "clientSecret": string,
  "responseType": {
    object (OAuthResponseType)
  }
}
Felder
name

string

Der Name der OAuthIdpConfig-Ressource, z. B. „projects/my-awesome-project/oauthIdpConfigs/oauth-config-id“. Wird bei Erstellungsanfragen ignoriert.
clientId

string

Die Client-ID eines OAuth-Clients.
issuer

string

Für OIDC-Identitätsanbieter die Aussteller-ID.
displayName

string

Der von den Entwicklern festgelegte Anzeigename der Konfiguration.
enabled

boolean

„Wahr“, wenn der Nutzer sich beim Anbieter anmelden kann.
clientSecret

string

Der Clientschlüssel des OAuth-Clients, um den OIDC-Codeablauf zu aktivieren.
responseType

object (OAuthResponseType)

Der Antworttyp, der im OAuth-Autorisierungsablauf angefordert werden soll. Sie können entweder idToken oder code auf „wahr“ setzen, aber nicht beide. Die gleichzeitige Einstellung beider Typen auf „wahr“ ({code: true, idToken: true}) wird noch nicht unterstützt.

OAuthResponseType

Der Antworttyp, der im OAuth-Autorisierungsablauf angefordert werden soll. Sie können entweder idToken oder code auf „wahr“ setzen, aber nicht beide. Die gleichzeitige Einstellung beider Typen auf „wahr“ ({code: true, idToken: true}) wird noch nicht unterstützt.

Eine Zuordnung des Antworttyps zum OAuth 2.0-Ablauf finden Sie unter https://openid.net/specs/openid-connect-core-1_0.html#Authentication.

JSON-Darstellung 
{
  "idToken": boolean,
  "code": boolean,
  "token": boolean
}
Felder
idToken

boolean

Wenn „wahr“ festgelegt ist, wird das ID-Token vom Autorisierungsendpunkt des IdP zurückgegeben.
code

boolean

Wenn „wahr“ festgelegt ist, wird der Autorisierungscode vom Autorisierungsendpunkt des IdP zurückgegeben.
token
(deprecated)

boolean

Nicht verwenden. Der Antworttyp token wird derzeit nicht unterstützt.

Methoden

create

 Erstellen Sie eine OIDC-IdP-Konfiguration für ein Identity Toolkit-Projekt.

delete

 OIDC-IdP-Konfiguration für ein Identity Toolkit-Projekt löschen

get

 Rufen Sie eine OIDC-IdP-Konfiguration für ein Identity Toolkit-Projekt ab.

list

 Liste aller OIDC-IdP-Konfigurationen für ein Identity Toolkit-Projekt auflisten

patch

 Aktualisieren Sie die OIDC-IdP-Konfiguration für ein Identity Toolkit-Projekt.