Identity Toolkit API

Mit der Google Identity Toolkit API können Sie offene Standards verwenden, um die Identität eines Nutzers zu überprüfen.

Dienst: identitytoolkit.googleapis.com

Wir empfehlen, diesen Dienst mit den von Google bereitgestellten Clientbibliotheken aufzurufen. Wenn Ihre Anwendung diesen Dienst mit Ihren eigenen Bibliotheken aufrufen muss, verwenden Sie die folgenden Informationen, wenn Sie die API-Anfragen senden.

Discovery-Dokument

Ein Discovery-Dokument ist eine maschinenlesbare Spezifikation zum Beschreiben und Nutzen von REST APIs. Sie wird verwendet, um Clientbibliotheken, IDE-Plug-ins und andere Tools zu erstellen, die mit Google APIs interagieren. Ein Dienst kann mehrere Discovery-Dokumente haben. Der Dienst bietet die folgenden Discovery-Dokumente:

Dienstendpunkt

Ein Dienstendpunkt ist eine Basis-URL, die die Netzwerkadresse eines API-Dienstes angibt. Ein Dienst kann mehrere Dienstendpunkte haben. Dieser Dienst hat den folgenden Dienstendpunkt und alle nachstehenden URIs beziehen sich auf ihn:

  • https://identitytoolkit.googleapis.com

REST-Ressource: v2

Methoden
getPasswordPolicy GET /v2/passwordPolicy
Ruft die Konfiguration der Passwortrichtlinie für das Projekt oder den Mandanten ab.
getRecaptchaConfig GET /v2/recaptchaConfig
Ruft Parameter ab, die für die reCAPTCHA-Analyse erforderlich sind.

REST-Ressource: v2.accounts

Methoden
revokeToken POST /v2/accounts:revokeToken
Widerruft das Token eines Nutzers bei einem Identitätsanbieter (IdP).

REST-Ressource: v2.accounts.mfaEnrollment

Methoden
finalize POST /v2/accounts/mfaEnrollment:finalize
Die Registrierung eines zweiten Faktors für den Nutzer ist abgeschlossen.
start POST /v2/accounts/mfaEnrollment:start
Schritt 1 der MFA-Registrierung.
withdraw POST /v2/accounts/mfaEnrollment:withdraw
Entfernt einen der registrierten zweiten Faktoren für ein Konto.

REST-Ressource: v2.accounts.mfaSignIn

Methoden
finalize POST /v2/accounts/mfaSignIn:finalize
MFA-Abfrage bestätigen und Anmeldung ausführen
start POST /v2/accounts/mfaSignIn:start
MFA-Herausforderung senden

REST-Ressource: v2.defaultSupportedIdps

Methoden
list GET /admin/v2/defaultSupportedIdps
Listet alle standardmäßig unterstützten Identitätsanbieter auf.

REST-Ressource: v2.projects

Methoden
getConfig GET /admin/v2/{name=projects/*/config}
Identity Toolkit-Projektkonfiguration abrufen.
updateConfig PATCH /admin/v2/{config.name=projects/*/config}
Identity Toolkit-Projektkonfiguration aktualisieren.

REST-Ressource: v2.projects.defaultSupportedIdpConfigs

Methoden
create POST /admin/v2/{parent=projects/*}/defaultSupportedIdpConfigs
Standardmäßig unterstützte IdP-Konfiguration für ein Identity Toolkit-Projekt erstellen.
delete DELETE /admin/v2/{name=projects/*/defaultSupportedIdpConfigs/*}
Eine standardmäßig unterstützte IdP-Konfiguration für ein Identity Toolkit-Projekt löschen.
get GET /admin/v2/{name=projects/*/defaultSupportedIdpConfigs/*}
Standardmäßig unterstützte IdP-Konfiguration für ein Identity Toolkit-Projekt abrufen.
list GET /admin/v2/{parent=projects/*}/defaultSupportedIdpConfigs
Listet alle standardmäßig unterstützten IdP-Konfigurationen für ein Identity Toolkit-Projekt auf.
patch PATCH /admin/v2/{defaultSupportedIdpConfig.name=projects/*/defaultSupportedIdpConfigs/*}
Standardkonfiguration eines unterstützten Identitätsanbieters für ein Identity Toolkit-Projekt aktualisieren.

REST-Ressource: v2.projects.domain

Methoden
verify POST /admin/v2/{resource=projects/*}/domain:verify
Prüfen Sie, ob die angeforderte benutzerdefinierte Domain die erforderlichen DNS-Einträge hat.

REST-Ressource: v2.projects.identityPlatform

Methoden
initializeAuth POST /v2/{project=projects/*}/identityPlatform:initializeAuth
Identity Platform für ein Cloud-Projekt initialisieren.

REST-Ressource: v2.projects.inboundSamlConfigs

Methoden
create POST /admin/v2/{parent=projects/*}/inboundSamlConfigs
Eine eingehende SAML-Konfiguration für ein Identity Toolkit-Projekt erstellen.
delete DELETE /admin/v2/{name=projects/*/inboundSamlConfigs/*}
Eingehende SAML-Konfiguration für ein Identity Toolkit-Projekt löschen.
get GET /admin/v2/{name=projects/*/inboundSamlConfigs/*}
Eingehende SAML-Konfiguration für ein Identity Toolkit-Projekt abrufen.
list GET /admin/v2/{parent=projects/*}/inboundSamlConfigs
Listet alle eingehenden SAML-Konfigurationen für ein Identity Toolkit-Projekt auf.
patch PATCH /admin/v2/{inboundSamlConfig.name=projects/*/inboundSamlConfigs/*}
Eine eingehende SAML-Konfiguration für ein Identity Toolkit-Projekt aktualisieren.

REST-Ressource: v2.projects.oauthIdpConfigs

Methoden
create POST /admin/v2/{parent=projects/*}/oauthIdpConfigs
OIDC-IdP-Konfiguration für ein Identity Toolkit-Projekt erstellen.
delete DELETE /admin/v2/{name=projects/*/oauthIdpConfigs/*}
OIDC-IdP-Konfiguration für ein Identity Toolkit-Projekt löschen.
get GET /admin/v2/{name=projects/*/oauthIdpConfigs/*}
OIDC-IdP-Konfiguration für ein Identity Toolkit-Projekt abrufen.
list GET /admin/v2/{parent=projects/*}/oauthIdpConfigs
Alle OIDC-IdP-Konfigurationen für ein Identity Toolkit-Projekt auflisten.
patch PATCH /admin/v2/{oauthIdpConfig.name=projects/*/oauthIdpConfigs/*}
OIDC-IdP-Konfiguration für ein Identity Toolkit-Projekt aktualisieren.

REST-Ressource: v2.projects.tenants

Methoden
create POST /v2/{parent=projects/*}/tenants
Mandanten erstellen.
delete DELETE /v2/{name=projects/*/tenants/*}
Mandanten löschen.
get GET /v2/{name=projects/*/tenants/*}
Mandanten abrufen.
getIamPolicy POST /admin/v2/{resource=projects/*/tenants/*}:getIamPolicy
Ruft die Zugriffssteuerungsrichtlinie für eine Ressource ab.
list GET /v2/{parent=projects/*}/tenants
Listet die Kunden unter dem angegebenen Kundenservicemitarbeiterprojekt auf.
patch PATCH /v2/{tenant.name=projects/*/tenants/*}
Mandanten aktualisieren.
setIamPolicy POST /admin/v2/{resource=projects/*/tenants/*}:setIamPolicy
Legt die Zugriffssteuerungsrichtlinie für eine Ressource fest.
testIamPermissions POST /admin/v2/{resource=projects/*/tenants/*}:testIamPermissions
Gibt die Berechtigungen des Aufrufers für eine Ressource zurück.

REST-Ressource: v2.projects.tenants.defaultSupportedIdpConfigs

Methoden
create POST /v2/{parent=projects/*/tenants/*}/defaultSupportedIdpConfigs
Standardmäßig unterstützte IdP-Konfiguration für ein Identity Toolkit-Projekt erstellen.
delete DELETE /v2/{name=projects/*/tenants/*/defaultSupportedIdpConfigs/*}
Eine standardmäßig unterstützte IdP-Konfiguration für ein Identity Toolkit-Projekt löschen.
get GET /v2/{name=projects/*/tenants/*/defaultSupportedIdpConfigs/*}
Standardmäßig unterstützte IdP-Konfiguration für ein Identity Toolkit-Projekt abrufen.
list GET /v2/{parent=projects/*/tenants/*}/defaultSupportedIdpConfigs
Listet alle standardmäßig unterstützten IdP-Konfigurationen für ein Identity Toolkit-Projekt auf.
patch PATCH /v2/{defaultSupportedIdpConfig.name=projects/*/tenants/*/defaultSupportedIdpConfigs/*}
Standardkonfiguration eines unterstützten Identitätsanbieters für ein Identity Toolkit-Projekt aktualisieren.

REST-Ressource: v2.projects.tenants.domain

Methoden
verify POST /admin/v2/{resource=projects/*/tenants/*}/domain:verify
Prüfen Sie, ob die angeforderte benutzerdefinierte Domain die erforderlichen DNS-Einträge hat.

REST-Ressource: v2.projects.tenants.inboundSamlConfigs

Methoden
create POST /v2/{parent=projects/*/tenants/*}/inboundSamlConfigs
Eine eingehende SAML-Konfiguration für ein Identity Toolkit-Projekt erstellen.
delete DELETE /v2/{name=projects/*/tenants/*/inboundSamlConfigs/*}
Eingehende SAML-Konfiguration für ein Identity Toolkit-Projekt löschen.
get GET /v2/{name=projects/*/tenants/*/inboundSamlConfigs/*}
Eingehende SAML-Konfiguration für ein Identity Toolkit-Projekt abrufen.
list GET /v2/{parent=projects/*/tenants/*}/inboundSamlConfigs
Listet alle eingehenden SAML-Konfigurationen für ein Identity Toolkit-Projekt auf.
patch PATCH /v2/{inboundSamlConfig.name=projects/*/tenants/*/inboundSamlConfigs/*}
Eine eingehende SAML-Konfiguration für ein Identity Toolkit-Projekt aktualisieren.

REST-Ressource: v2.projects.tenants.oauthIdpConfigs

Methoden
create POST /v2/{parent=projects/*/tenants/*}/oauthIdpConfigs
OIDC-IdP-Konfiguration für ein Identity Toolkit-Projekt erstellen.
delete DELETE /v2/{name=projects/*/tenants/*/oauthIdpConfigs/*}
OIDC-IdP-Konfiguration für ein Identity Toolkit-Projekt löschen.
get GET /v2/{name=projects/*/tenants/*/oauthIdpConfigs/*}
OIDC-IdP-Konfiguration für ein Identity Toolkit-Projekt abrufen.
list GET /v2/{parent=projects/*/tenants/*}/oauthIdpConfigs
Alle OIDC-IdP-Konfigurationen für ein Identity Toolkit-Projekt auflisten.
patch PATCH /v2/{oauthIdpConfig.name=projects/*/tenants/*/oauthIdpConfigs/*}
OIDC-IdP-Konfiguration für ein Identity Toolkit-Projekt aktualisieren.

REST-Ressource: v1

Methoden
getProjects GET /v1/projects
Ruft die öffentliche Identity Toolkit-Konfiguration eines Projekts ab.
getPublicKeys GET /v1/publicKeys
Ruft öffentliche Schlüssel des Legacy Identity Toolkit-Token-Unterzeichners ab, damit Dritte das Legacy-ID-Token verifizieren können.
getRecaptchaParams GET /v1/recaptchaParams
Ruft die Parameter ab, die zum Generieren einer reCAPTCHA-Aufgabe erforderlich sind.
getSessionCookiePublicKeys GET /v1/sessionCookiePublicKeys
Ruft den Satz öffentlicher Schlüssel des JSON Web Token (JWT)-Signers für das Sitzungscookie ab, mit dem das über createSessionCookie erstellte Sitzungscookie validiert werden kann.

REST-Ressource: v1.accounts

Methoden
createAuthUri POST /v1/accounts:createAuthUri
Prüft, ob ein Nutzerkonto mit der E-Mail-Adresse registriert ist, und gibt den Wert zurück.
delete POST /v1/accounts:delete
Löscht das Konto eines Nutzers.
issueSamlResponse POST /v1/accounts:issueSamlResponse
Experimentell
lookup POST /v1/accounts:lookup
Ruft Kontoinformationen für alle übereinstimmenden Konten ab.
resetPassword POST /v1/accounts:resetPassword
Das Passwort eines Kontos wird entweder mit einem Out-of-Band-Code zurückgesetzt, der mit sendOobCode generiert wurde, oder durch Angabe der E-Mail-Adresse und des Passworts des zu ändernden Kontos.
sendOobCode POST /v1/accounts:sendOobCode
Sendet einen externen Bestätigungscode für ein Konto.
sendVerificationCode POST /v1/accounts:sendVerificationCode
Hiermit wird ein SMS-Bestätigungscode für die Anmeldung per Telefonnummer gesendet.
signInWithCustomToken POST /v1/accounts:signInWithCustomToken
Meldet einen Nutzer an oder registriert ihn, indem ein benutzerdefiniertes Auth-Token ausgetauscht wird.
signInWithEmailLink POST /v1/accounts:signInWithEmailLink
Nutzer mit einem Out-of-Band-Code über einen E-Mail-Link anmelden oder registrieren.
signInWithGameCenter POST /v1/accounts:signInWithGameCenter
Meldet einen Nutzer mit iOS-Game Center-Anmeldedaten an oder registriert ihn.
signInWithIdp POST /v1/accounts:signInWithIdp
Meldet einen Nutzer mit Anmeldedaten eines Identitätsanbieters an oder registriert ihn.
signInWithPassword POST /v1/accounts:signInWithPassword
Nutzer mit E-Mail-Adresse und Passwort anmelden.
signInWithPhoneNumber POST /v1/accounts:signInWithPhoneNumber
Schließt einen Authentifizierungsversuch per Telefonnummer ab.
signUp POST /v1/accounts:signUp
Ermöglicht die Registrierung eines neuen Nutzers mit E-Mail-Adresse und Passwort oder eines anonymen Nutzers oder wandelt einen anonymen Nutzer in einen Nutzer mit E-Mail-Adresse und Passwort um.
update POST /v1/accounts:update
Aktualisiert kontobezogene Informationen für den angegebenen Nutzer, indem bestimmte Felder festgelegt oder Aktionscodes angewendet werden.
verifyIosClient POST /v1/accounts:verifyIosClient
Prüft, ob ein iOS-Client ein echtes iOS-Gerät ist.

REST-Ressource: v1.projects

Methoden
accounts POST /v1/projects/{targetProjectId}/accounts
Ermöglicht die Registrierung eines neuen Nutzers mit E-Mail-Adresse und Passwort oder eines anonymen Nutzers oder wandelt einen anonymen Nutzer in einen Nutzer mit E-Mail-Adresse und Passwort um.
createSessionCookie POST /v1/projects/{targetProjectId}:createSessionCookie
Erstellt ein Sitzungscookie für das angegebene Identity Platform-ID-Token.
queryAccounts POST /v1/projects/{targetProjectId}:queryAccounts
Sucht anhand der Bedingungen in der Anfrage nach Nutzerkonten innerhalb eines Projekts oder eines Tenants.

REST-Ressource: v1.projects.accounts

Methoden
batchCreate POST /v1/projects/{targetProjectId}/accounts:batchCreate
Mehrere Konten in das Google Cloud-Projekt hochlädt.
batchDelete POST /v1/projects/{targetProjectId}/accounts:batchDelete
Mit dieser Option können Sie mehrere Konten gleichzeitig löschen.
batchGet GET /v1/projects/{targetProjectId}/accounts:batchGet
Kontoinformationen für alle Konten im Projekt auf unterschiedliche Seiten heruntergeladen werden.
delete POST /v1/projects/{targetProjectId}/accounts:delete
Löscht das Konto eines Nutzers.
lookup POST /v1/projects/{targetProjectId}/accounts:lookup
Ruft Kontoinformationen für alle übereinstimmenden Konten ab.
query POST /v1/projects/{targetProjectId}/accounts:query
Sucht anhand der Bedingungen in der Anfrage nach Nutzerkonten innerhalb eines Projekts oder eines Tenants.
sendOobCode POST /v1/projects/{targetProjectId}/accounts:sendOobCode
Sendet einen externen Bestätigungscode für ein Konto.
update POST /v1/projects/{targetProjectId}/accounts:update
Aktualisiert kontobezogene Informationen für den angegebenen Nutzer, indem bestimmte Felder festgelegt oder Aktionscodes angewendet werden.

REST-Ressource: v1.projects.tenants

Methoden
accounts POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts
Ermöglicht die Registrierung eines neuen Nutzers mit E-Mail-Adresse und Passwort oder eines anonymen Nutzers oder wandelt einen anonymen Nutzer in einen Nutzer mit E-Mail-Adresse und Passwort um.
createSessionCookie POST /v1/projects/{targetProjectId}/tenants/{tenantId}:createSessionCookie
Erstellt ein Sitzungscookie für das angegebene Identity Platform-ID-Token.

REST-Ressource: v1.projects.tenants.accounts

Methoden
batchCreate POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:batchCreate
Mehrere Konten in das Google Cloud-Projekt hochlädt.
batchDelete POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:batchDelete
Mit dieser Option können Sie mehrere Konten gleichzeitig löschen.
batchGet GET /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:batchGet
Kontoinformationen für alle Konten im Projekt auf unterschiedliche Seiten heruntergeladen werden.
delete POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:delete
Löscht das Konto eines Nutzers.
lookup POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:lookup
Ruft Kontoinformationen für alle übereinstimmenden Konten ab.
query POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:query
Sucht anhand der Bedingungen in der Anfrage nach Nutzerkonten innerhalb eines Projekts oder eines Tenants.
sendOobCode POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:sendOobCode
Sendet einen externen Bestätigungscode für ein Konto.
update POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:update
Aktualisiert kontobezogene Informationen für den angegebenen Nutzer, indem bestimmte Felder festgelegt oder Aktionscodes angewendet werden.