Identity Toolkit API

La API de Google Identity Toolkit te permite usar estándares abiertos para verificar la identidad de un usuario.

Servicio: identitytoolkit.googleapis.com

Para llamar a este servicio, te recomendamos que uses las bibliotecas cliente que proporciona Google. Si tu aplicación necesita usar tus propias bibliotecas para llamar a este servicio, usa la información siguiente cuando realices las solicitudes a la API.

Documento de descubrimiento

Un Documento de descubrimiento es una especificación procesable para describir y consumir las API de REST. Se usa para compilar bibliotecas cliente, complementos IDE y otras herramientas que interactúan con las API de Google. Un servicio puede proporcionar varios documentos de descubrimiento. Este servicio proporciona los siguientes documentos de Discovery:

Extremo de servicio

Un extremo de servicio es una URL base que especifica la dirección de la red de un servicio de API. Un servicio puede tener varios extremos de servicio. Este servicio tiene el siguiente extremo, y todos los URI que se muestran a continuación son relativos a él:

  • https://identitytoolkit.googleapis.com

Recurso de REST: v2

Métodos
getPasswordPolicy GET /v2/passwordPolicy
Obtiene la configuración de la política de contraseñas establecida en el proyecto o el inquilino.
getRecaptchaConfig GET /v2/recaptchaConfig
Obtiene los parámetros necesarios para el análisis de reCAPTCHA.

Recurso de REST: v2.accounts

Métodos
revokeToken POST /v2/accounts:revokeToken
Revoca el token de un usuario de un proveedor de identidad (IdP).

Recurso de REST: v2.accounts.mfaEnrollment

Métodos
finalize POST /v2/accounts/mfaEnrollment:finalize
Finaliza la inscripción de un segundo factor para el usuario.
start POST /v2/accounts/mfaEnrollment:start
Primer paso del proceso de inscripción de la AUA.
withdraw POST /v2/accounts/mfaEnrollment:withdraw
Revokes one second factor from the enrolled second factors for an account.

Recurso de REST: v2.accounts.mfaSignIn

Métodos
finalize POST /v2/accounts/mfaSignIn:finalize
Verifica el desafío de la MFA y realiza el acceso
start POST /v2/accounts/mfaSignIn:start
Envía el desafío de MFA

Recurso de REST: v2.defaultSupportedIdps

Métodos
list GET /admin/v2/defaultSupportedIdps
Enumera todos los proveedores de identidad admitidos de forma predeterminada.

Recurso de REST: v2.projects

Métodos
getConfig GET /admin/v2/{name=projects/*/config}
Recupera la configuración de un proyecto de Identity Toolkit.
updateConfig PATCH /admin/v2/{config.name=projects/*/config}
Actualiza la configuración de un proyecto de Identity Toolkit.

Recurso de REST: v2.projects.defaultSupportedIdpConfigs

Métodos
create POST /admin/v2/{parent=projects/*}/defaultSupportedIdpConfigs
Crea una configuración de IDP compatible predeterminada para un proyecto de Identity Toolkit.
delete DELETE /admin/v2/{name=projects/*/defaultSupportedIdpConfigs/*}
Borra una configuración de IDP compatible predeterminada para un proyecto de Identity Toolkit.
get GET /admin/v2/{name=projects/*/defaultSupportedIdpConfigs/*}
Recupera una configuración de IdP compatible predeterminada para un proyecto de Identity Toolkit.
list GET /admin/v2/{parent=projects/*}/defaultSupportedIdpConfigs
Muestra una lista de todas las configuraciones de IDP predeterminadas admitidas para un proyecto de Identity Toolkit.
patch PATCH /admin/v2/{defaultSupportedIdpConfig.name=projects/*/defaultSupportedIdpConfigs/*}
Actualiza una configuración de IDP compatible predeterminada para un proyecto de Identity Toolkit.

Recurso de REST: v2.projects.domain

Métodos
verify POST /admin/v2/{resource=projects/*}/domain:verify
Verifica que el dominio personalizado solicitado tenga los registros DNS necesarios.

Recurso de REST: v2.projects.identityPlatform

Métodos
initializeAuth POST /v2/{project=projects/*}/identityPlatform:initializeAuth
Inicializa Identity Platform para un proyecto de Cloud.

Recurso de REST: v2.projects.inboundSamlConfigs

Métodos
create POST /admin/v2/{parent=projects/*}/inboundSamlConfigs
Crea una configuración SAML de entrada para un proyecto de Identity Toolkit.
delete DELETE /admin/v2/{name=projects/*/inboundSamlConfigs/*}
Borra una configuración de SAML entrante para un proyecto de Identity Toolkit.
get GET /admin/v2/{name=projects/*/inboundSamlConfigs/*}
Recupera una configuración SAML de entrada para un proyecto de Identity Toolkit.
list GET /admin/v2/{parent=projects/*}/inboundSamlConfigs
Muestra una lista de todas las configuraciones SAML de entrada para un proyecto de Identity Toolkit.
patch PATCH /admin/v2/{inboundSamlConfig.name=projects/*/inboundSamlConfigs/*}
Actualiza una configuración de SAML entrante para un proyecto de Identity Toolkit.

Recurso de REST: v2.projects.oauthIdpConfigs

Métodos
create POST /admin/v2/{parent=projects/*}/oauthIdpConfigs
Crea una configuración de IDP de OIDC para un proyecto de Identity Toolkit.
delete DELETE /admin/v2/{name=projects/*/oauthIdpConfigs/*}
Borra la configuración de un IDP de OIDC para un proyecto de Identity Toolkit.
get GET /admin/v2/{name=projects/*/oauthIdpConfigs/*}
Recupera una configuración de IDP de OIDC para un proyecto de Identity Toolkit.
list GET /admin/v2/{parent=projects/*}/oauthIdpConfigs
Muestra una lista de todas las configuraciones del IDP de OIDC para un proyecto de Identity Toolkit.
patch PATCH /admin/v2/{oauthIdpConfig.name=projects/*/oauthIdpConfigs/*}
Actualiza la configuración de un IdP de OIDC para un proyecto de Identity Toolkit.

Recurso de REST: v2.projects.tenants

Métodos
create POST /v2/{parent=projects/*}/tenants
Crea un usuario.
delete DELETE /v2/{name=projects/*/tenants/*}
Borra un usuario.
get GET /v2/{name=projects/*/tenants/*}
Obtén un usuario.
getIamPolicy POST /admin/v2/{resource=projects/*/tenants/*}:getIamPolicy
Permite obtener la política de control de acceso de un recurso.
list GET /v2/{parent=projects/*}/tenants
Muestra una lista de los inquilinos del proyecto de agente determinado.
patch PATCH /v2/{tenant.name=projects/*/tenants/*}
Actualiza un usuario.
setIamPolicy POST /admin/v2/{resource=projects/*/tenants/*}:setIamPolicy
Configura la política de control de acceso de un recurso.
testIamPermissions POST /admin/v2/{resource=projects/*/tenants/*}:testIamPermissions
Muestra los permisos del emisor en un recurso.

Recurso de REST: v2.projects.tenants.defaultSupportedIdpConfigs

Métodos
create POST /v2/{parent=projects/*/tenants/*}/defaultSupportedIdpConfigs
Crea una configuración de IDP compatible predeterminada para un proyecto de Identity Toolkit.
delete DELETE /v2/{name=projects/*/tenants/*/defaultSupportedIdpConfigs/*}
Borra una configuración de IDP compatible predeterminada para un proyecto de Identity Toolkit.
get GET /v2/{name=projects/*/tenants/*/defaultSupportedIdpConfigs/*}
Recupera una configuración de IdP compatible predeterminada para un proyecto de Identity Toolkit.
list GET /v2/{parent=projects/*/tenants/*}/defaultSupportedIdpConfigs
Muestra una lista de todas las configuraciones de IDP predeterminadas admitidas para un proyecto de Identity Toolkit.
patch PATCH /v2/{defaultSupportedIdpConfig.name=projects/*/tenants/*/defaultSupportedIdpConfigs/*}
Actualiza una configuración de IDP compatible predeterminada para un proyecto de Identity Toolkit.

Recurso de REST: v2.projects.tenants.domain

Métodos
verify POST /admin/v2/{resource=projects/*/tenants/*}/domain:verify
Verifica que el dominio personalizado solicitado tenga los registros DNS necesarios.

Recurso de REST: v2.projects.tenants.inboundSamlConfigs

Métodos
create POST /v2/{parent=projects/*/tenants/*}/inboundSamlConfigs
Crea una configuración SAML de entrada para un proyecto de Identity Toolkit.
delete DELETE /v2/{name=projects/*/tenants/*/inboundSamlConfigs/*}
Borra una configuración de SAML entrante para un proyecto de Identity Toolkit.
get GET /v2/{name=projects/*/tenants/*/inboundSamlConfigs/*}
Recupera una configuración SAML de entrada para un proyecto de Identity Toolkit.
list GET /v2/{parent=projects/*/tenants/*}/inboundSamlConfigs
Muestra una lista de todas las configuraciones SAML de entrada para un proyecto de Identity Toolkit.
patch PATCH /v2/{inboundSamlConfig.name=projects/*/tenants/*/inboundSamlConfigs/*}
Actualiza una configuración de SAML entrante para un proyecto de Identity Toolkit.

Recurso de REST: v2.projects.tenants.oauthIdpConfigs

Métodos
create POST /v2/{parent=projects/*/tenants/*}/oauthIdpConfigs
Crea una configuración de IDP de OIDC para un proyecto de Identity Toolkit.
delete DELETE /v2/{name=projects/*/tenants/*/oauthIdpConfigs/*}
Borra la configuración de un IDP de OIDC para un proyecto de Identity Toolkit.
get GET /v2/{name=projects/*/tenants/*/oauthIdpConfigs/*}
Recupera una configuración de IDP de OIDC para un proyecto de Identity Toolkit.
list GET /v2/{parent=projects/*/tenants/*}/oauthIdpConfigs
Muestra una lista de todas las configuraciones del IDP de OIDC para un proyecto de Identity Toolkit.
patch PATCH /v2/{oauthIdpConfig.name=projects/*/tenants/*/oauthIdpConfigs/*}
Actualiza la configuración de un IdP de OIDC para un proyecto de Identity Toolkit.

Recurso de REST: v1

Métodos
getProjects GET /v1/projects
Obtiene la configuración pública de Identity Toolkit de un proyecto.
getPublicKeys GET /v1/publicKeys
Recupera las claves públicas del firmante de tokens de Identity Toolkit heredado para permitir que terceros verifiquen el token de ID heredado.
getRecaptchaParams GET /v1/recaptchaParams
Obtiene los parámetros necesarios para generar un desafío de reCAPTCHA.
getSessionCookiePublicKeys GET /v1/sessionCookiePublicKeys
Recupera el conjunto de claves públicas del firmante de token web JSON (JWT) de la cookie de sesión que se puede usar para validar la cookie de sesión creada a través de createSessionCookie.

Recurso de REST: v1.accounts

Métodos
createAuthUri POST /v1/accounts:createAuthUri
Si se especifica un identificador de correo electrónico, comprueba y muestra si hay alguna cuenta de usuario registrada con el correo electrónico.
delete POST /v1/accounts:delete
Borra la cuenta de un usuario.
issueSamlResponse POST /v1/accounts:issueSamlResponse
Experimental
lookup POST /v1/accounts:lookup
Obtiene información de la cuenta para todas las cuentas que coinciden.
resetPassword POST /v1/accounts:resetPassword
Restablece la contraseña de una cuenta con un código fuera de banda que genera sendOobCode o especificando el correo electrónico y la contraseña de la cuenta que se modificará.
sendOobCode POST /v1/accounts:sendOobCode
Envía un código de confirmación fuera de banda para una cuenta.
sendVerificationCode POST /v1/accounts:sendVerificationCode
Envía un código de verificación por SMS para el acceso con número de teléfono.
signInWithCustomToken POST /v1/accounts:signInWithCustomToken
Intercambia un token de Auth personalizado para que un usuario acceda o se registre.
signInWithEmailLink POST /v1/accounts:signInWithEmailLink
Permite que un usuario acceda o se registre con un código fuera de banda desde un vínculo de correo electrónico.
signInWithGameCenter POST /v1/accounts:signInWithGameCenter
Permite que un usuario acceda o se registre con credenciales de Game Center de iOS.
signInWithIdp POST /v1/accounts:signInWithIdp
Accede o registra a un usuario con credenciales de un proveedor de identidad (IdP).
signInWithPassword POST /v1/accounts:signInWithPassword
Permite que un usuario acceda con un correo electrónico y una contraseña.
signInWithPhoneNumber POST /v1/accounts:signInWithPhoneNumber
Completa un intento de autenticación con número de teléfono.
signUp POST /v1/accounts:signUp
Registra un usuario nuevo con correo electrónico y contraseña o un usuario anónimo, o bien actualiza un usuario anónimo a correo electrónico y contraseña.
update POST /v1/accounts:update
Actualiza la información relacionada con la cuenta del usuario especificado configurando campos específicos o aplicando códigos de acción.
verifyIosClient POST /v1/accounts:verifyIosClient
Verifica que un cliente de iOS sea un dispositivo iOS real.

Recurso de REST: v1.projects

Métodos
accounts POST /v1/projects/{targetProjectId}/accounts
Registra un usuario nuevo con correo electrónico y contraseña o un usuario anónimo, o bien actualiza un usuario anónimo a correo electrónico y contraseña.
createSessionCookie POST /v1/projects/{targetProjectId}:createSessionCookie
Crea una cookie de sesión para el token de ID de Identity Platform determinado.
queryAccounts POST /v1/projects/{targetProjectId}:queryAccounts
Busca cuentas de usuario dentro de un proyecto o un inquilino según las condiciones de la solicitud.

Recurso de REST: v1.projects.accounts

Métodos
batchCreate POST /v1/projects/{targetProjectId}/accounts:batchCreate
Sube varias cuentas al proyecto de Google Cloud.
batchDelete POST /v1/projects/{targetProjectId}/accounts:batchDelete
La eliminación masiva borra varias cuentas.
batchGet GET /v1/projects/{targetProjectId}/accounts:batchGet
Descarga la información de la cuenta de todas las cuentas del proyecto de forma paginada.
delete POST /v1/projects/{targetProjectId}/accounts:delete
Borra la cuenta de un usuario.
lookup POST /v1/projects/{targetProjectId}/accounts:lookup
Obtiene información de la cuenta para todas las cuentas que coinciden.
query POST /v1/projects/{targetProjectId}/accounts:query
Busca cuentas de usuario dentro de un proyecto o un inquilino según las condiciones de la solicitud.
sendOobCode POST /v1/projects/{targetProjectId}/accounts:sendOobCode
Envía un código de confirmación fuera de banda para una cuenta.
update POST /v1/projects/{targetProjectId}/accounts:update
Actualiza la información relacionada con la cuenta del usuario especificado configurando campos específicos o aplicando códigos de acción.

Recurso de REST: v1.projects.tenants

Métodos
accounts POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts
Registra un usuario nuevo con correo electrónico y contraseña o un usuario anónimo, o bien actualiza un usuario anónimo a correo electrónico y contraseña.
createSessionCookie POST /v1/projects/{targetProjectId}/tenants/{tenantId}:createSessionCookie
Crea una cookie de sesión para el token de ID de Identity Platform determinado.

Recurso de REST: v1.projects.tenants.accounts

Métodos
batchCreate POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:batchCreate
Sube varias cuentas al proyecto de Google Cloud.
batchDelete POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:batchDelete
La eliminación masiva borra varias cuentas.
batchGet GET /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:batchGet
Descarga la información de la cuenta de todas las cuentas del proyecto de forma paginada.
delete POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:delete
Borra la cuenta de un usuario.
lookup POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:lookup
Obtiene información de la cuenta para todas las cuentas que coinciden.
query POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:query
Busca cuentas de usuario dentro de un proyecto o un inquilino según las condiciones de la solicitud.
sendOobCode POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:sendOobCode
Envía un código de confirmación fuera de banda para una cuenta.
update POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:update
Actualiza la información relacionada con la cuenta del usuario especificado configurando campos específicos o aplicando códigos de acción.