Identity Toolkit API

A API Google Identity Toolkit permite usar padrões abertos para verificar a identidade de um usuário.

Serviço: identitytoolkit.googleapis.com

Para chamar esse serviço, recomendamos que você use as bibliotecas de cliente fornecidas pelo Google. Caso seu aplicativo precise usar suas próprias bibliotecas para chamar esse serviço, use as informações a seguir quando fizer as solicitações da API.

Documento de descoberta

Um Documento de descoberta é uma especificação legível por máquina para descrever e consumir APIs REST. Ele é usado para criar bibliotecas de cliente, plug-ins IDE e outras ferramentas que interagem com as APIs do Google. Um serviço pode fornecer vários documentos de descoberta. Este serviço apresenta os documentos de descoberta abaixo:

Endpoint de serviço

Um endpoint de serviço é um URL de base que especifica o endereço de rede de um serviço de API. Um serviço pode ter vários endpoints de serviço. Este serviço tem o endpoint a seguir e todos os URIs abaixo são relativos a ele:

  • https://identitytoolkit.googleapis.com

Recurso da REST: v2

Métodos
getPasswordPolicy GET /v2/passwordPolicy
Recebe a configuração da política de senha definida no projeto ou locatário.
getRecaptchaConfig GET /v2/recaptchaConfig
Recebe os parâmetros necessários para a análise do reCAPTCHA.

Recurso REST: v2.accounts

Métodos
revokeToken POST /v2/accounts:revokeToken
Revoga o token de um usuário de um provedor de identidade (IdP).

Recurso REST: v2.accounts.mfaEnrollment

Métodos
finalize POST /v2/accounts/mfaEnrollment:finalize
Termina o registro de um segundo fator para o usuário.
start POST /v2/accounts/mfaEnrollment:start
Etapa 1 do processo de registro do MFA.
withdraw POST /v2/accounts/mfaEnrollment:withdraw
Cancela um segundo fator dos segundos fatores registrados de uma conta.

Recurso REST: v2.accounts.mfaSignIn

Métodos
finalize POST /v2/accounts/mfaSignIn:finalize
Verifica o desafio de MFA e faz o login
start POST /v2/accounts/mfaSignIn:start
Envia o desafio de MFA

Recurso REST: v2.defaultSupportedIdps

Métodos
list GET /admin/v2/defaultSupportedIdps
Lista todos os IdPs padrão compatíveis.

Recurso REST: v2.projects

Métodos
getConfig GET /admin/v2/{name=projects/*/config}
Extrai uma configuração de projeto do Identity Toolkit.
updateConfig PATCH /admin/v2/{config.name=projects/*/config}
Atualize a configuração de um projeto do Identity Toolkit.

Recurso REST: v2.projects.defaultSupportedIdpConfigs

Métodos
create POST /admin/v2/{parent=projects/*}/defaultSupportedIdpConfigs
Crie uma configuração de IdP padrão com suporte para um projeto do Identity Toolkit.
delete DELETE /admin/v2/{name=projects/*/defaultSupportedIdpConfigs/*}
Exclua uma configuração de IdP padrão com suporte para um projeto do Identity Toolkit.
get GET /admin/v2/{name=projects/*/defaultSupportedIdpConfigs/*}
Extraia uma configuração de IdP padrão com suporte para um projeto do Identity Toolkit.
list GET /admin/v2/{parent=projects/*}/defaultSupportedIdpConfigs
Lista todas as configurações de IdP padrão com suporte para um projeto do Identity Toolkit.
patch PATCH /admin/v2/{defaultSupportedIdpConfig.name=projects/*/defaultSupportedIdpConfigs/*}
Atualize uma configuração de IdP padrão com suporte para um projeto do Identity Toolkit.

Recurso REST: v2.projects.domain

Métodos
verify POST /admin/v2/{resource=projects/*}/domain:verify
Verifique se o domínio personalizado solicitado tem os registros DNS necessários.

Recurso REST: v2.projects.identityPlatform

Métodos
initializeAuth POST /v2/{project=projects/*}/identityPlatform:initializeAuth
Inicialize o Identity Platform para um projeto do Cloud.

Recurso REST: v2.projects.inboundSamlConfigs

Métodos
create POST /admin/v2/{parent=projects/*}/inboundSamlConfigs
Crie uma configuração de SAML de entrada para um projeto do Identity Toolkit.
delete DELETE /admin/v2/{name=projects/*/inboundSamlConfigs/*}
Exclua uma configuração de SAML de entrada para um projeto do Identity Toolkit.
get GET /admin/v2/{name=projects/*/inboundSamlConfigs/*}
Extraia uma configuração de entrada de SAML para um projeto do Identity Toolkit.
list GET /admin/v2/{parent=projects/*}/inboundSamlConfigs
Liste todas as configurações de entrada de SAML de um projeto do Identity Toolkit.
patch PATCH /admin/v2/{inboundSamlConfig.name=projects/*/inboundSamlConfigs/*}
Atualize uma configuração de SAML de entrada para um projeto do Identity Toolkit.

Recurso REST: v2.projects.oauthIdpConfigs

Métodos
create POST /admin/v2/{parent=projects/*}/oauthIdpConfigs
Crie uma configuração de IdP Oidc para um projeto do Identity Toolkit.
delete DELETE /admin/v2/{name=projects/*/oauthIdpConfigs/*}
Exclua uma configuração de IdP Oidc para um projeto do Identity Toolkit.
get GET /admin/v2/{name=projects/*/oauthIdpConfigs/*}
Extraia uma configuração de IdP do Oidc para um projeto do Identity Toolkit.
list GET /admin/v2/{parent=projects/*}/oauthIdpConfigs
Lista todas as configurações de IdP do Oidc para um projeto do Identity Toolkit.
patch PATCH /admin/v2/{oauthIdpConfig.name=projects/*/oauthIdpConfigs/*}
Atualize uma configuração de IdP do OIDC para um projeto do Identity Toolkit.

Recurso REST: v2.projects.tenants

Métodos
create POST /v2/{parent=projects/*}/tenants
Crie um locatário.
delete DELETE /v2/{name=projects/*/tenants/*}
Excluir um locatário.
get GET /v2/{name=projects/*/tenants/*}
Confira um locatário.
getIamPolicy POST /admin/v2/{resource=projects/*/tenants/*}:getIamPolicy
Busca a política de controle de acesso de um recurso.
list GET /v2/{parent=projects/*}/tenants
Lista os locatários no projeto de agente especificado.
patch PATCH /v2/{tenant.name=projects/*/tenants/*}
Atualizar um locatário.
setIamPolicy POST /admin/v2/{resource=projects/*/tenants/*}:setIamPolicy
Define a política de controle de acesso de um recurso.
testIamPermissions POST /admin/v2/{resource=projects/*/tenants/*}:testIamPermissions
Retorna as permissões do autor da chamada em um recurso.

Recurso REST: v2.projects.tenants.defaultSupportedIdpConfigs

Métodos
create POST /v2/{parent=projects/*/tenants/*}/defaultSupportedIdpConfigs
Crie uma configuração de IdP padrão com suporte para um projeto do Identity Toolkit.
delete DELETE /v2/{name=projects/*/tenants/*/defaultSupportedIdpConfigs/*}
Exclua uma configuração de IdP padrão com suporte para um projeto do Identity Toolkit.
get GET /v2/{name=projects/*/tenants/*/defaultSupportedIdpConfigs/*}
Extraia uma configuração de IdP padrão com suporte para um projeto do Identity Toolkit.
list GET /v2/{parent=projects/*/tenants/*}/defaultSupportedIdpConfigs
Lista todas as configurações de IdP padrão com suporte para um projeto do Identity Toolkit.
patch PATCH /v2/{defaultSupportedIdpConfig.name=projects/*/tenants/*/defaultSupportedIdpConfigs/*}
Atualize uma configuração de IdP padrão com suporte para um projeto do Identity Toolkit.

Recurso REST: v2.projects.tenants.domain

Métodos
verify POST /admin/v2/{resource=projects/*/tenants/*}/domain:verify
Verifique se o domínio personalizado solicitado tem os registros DNS necessários.

Recurso REST: v2.projects.tenants.inboundSamlConfigs

Métodos
create POST /v2/{parent=projects/*/tenants/*}/inboundSamlConfigs
Crie uma configuração de SAML de entrada para um projeto do Identity Toolkit.
delete DELETE /v2/{name=projects/*/tenants/*/inboundSamlConfigs/*}
Exclua uma configuração de SAML de entrada para um projeto do Identity Toolkit.
get GET /v2/{name=projects/*/tenants/*/inboundSamlConfigs/*}
Extraia uma configuração de entrada de SAML para um projeto do Identity Toolkit.
list GET /v2/{parent=projects/*/tenants/*}/inboundSamlConfigs
Liste todas as configurações de entrada de SAML de um projeto do Identity Toolkit.
patch PATCH /v2/{inboundSamlConfig.name=projects/*/tenants/*/inboundSamlConfigs/*}
Atualize uma configuração de SAML de entrada para um projeto do Identity Toolkit.

Recurso REST: v2.projects.tenants.oauthIdpConfigs

Métodos
create POST /v2/{parent=projects/*/tenants/*}/oauthIdpConfigs
Crie uma configuração de IdP Oidc para um projeto do Identity Toolkit.
delete DELETE /v2/{name=projects/*/tenants/*/oauthIdpConfigs/*}
Exclua uma configuração de IdP Oidc para um projeto do Identity Toolkit.
get GET /v2/{name=projects/*/tenants/*/oauthIdpConfigs/*}
Extraia uma configuração de IdP do Oidc para um projeto do Identity Toolkit.
list GET /v2/{parent=projects/*/tenants/*}/oauthIdpConfigs
Lista todas as configurações de IdP do Oidc para um projeto do Identity Toolkit.
patch PATCH /v2/{oauthIdpConfig.name=projects/*/tenants/*/oauthIdpConfigs/*}
Atualize uma configuração de IdP do OIDC para um projeto do Identity Toolkit.

Recurso REST: v1

Métodos
getProjects GET /v1/projects
Recebe a configuração pública do Identity Toolkit de um projeto.
getPublicKeys GET /v1/publicKeys
Recupera as chaves públicas do assinante de token do Identity Toolkit legado para permitir que terceiros verifiquem o token de ID legado.
getRecaptchaParams GET /v1/recaptchaParams
Recebe os parâmetros necessários para gerar um desafio reCAPTCHA.
getSessionCookiePublicKeys GET /v1/sessionCookiePublicKeys
Recupera o conjunto de chaves públicas do signatário do token JSON da Web (JWT) do cookie de sessão que pode ser usado para validar o cookie de sessão criado em createSessionCookie.

Recurso REST: v1.accounts

Métodos
createAuthUri POST /v1/accounts:createAuthUri
Se um identificador de e-mail for especificado, ele vai verificar e retornar se alguma conta de usuário está registrada com o e-mail.
delete POST /v1/accounts:delete
Exclui a conta de um usuário.
issueSamlResponse POST /v1/accounts:issueSamlResponse
Experimental
lookup POST /v1/accounts:lookup
Recebe informações de todas as contas correspondentes.
resetPassword POST /v1/accounts:resetPassword
Redefine a senha de uma conta usando um código fora da banda gerado por sendOobCode ou especificando o e-mail e a senha da conta a ser modificada.
sendOobCode POST /v1/accounts:sendOobCode
Envia um código de confirmação externo para uma conta.
sendVerificationCode POST /v1/accounts:sendVerificationCode
Envia um código de verificação por SMS para fazer login com o número de telefone.
signInWithCustomToken POST /v1/accounts:signInWithCustomToken
Faz o login ou o registro de um usuário trocando um token de autenticação personalizado.
signInWithEmailLink POST /v1/accounts:signInWithEmailLink
Faz login ou registra um usuário com um código fora da banda de um link de e-mail.
signInWithGameCenter POST /v1/accounts:signInWithGameCenter
Faz login ou registra um usuário com credenciais do Game Center para iOS.
signInWithIdp POST /v1/accounts:signInWithIdp
Faz login ou registra um usuário usando credenciais de um provedor de identidade (IdP).
signInWithPassword POST /v1/accounts:signInWithPassword
Faz login de um usuário com e-mail e senha.
signInWithPhoneNumber POST /v1/accounts:signInWithPhoneNumber
Conclui uma tentativa de autenticação por número de telefone.
signUp POST /v1/accounts:signUp
Registra um novo usuário ou usuário anônimo com e-mail e senha ou faz upgrade de um usuário anônimo para e-mail e senha.
update POST /v1/accounts:update
Atualiza as informações relacionadas à conta do usuário especificado definindo campos específicos ou aplicando códigos de ação.
verifyIosClient POST /v1/accounts:verifyIosClient
Verifica se um cliente iOS é um dispositivo iOS real.

Recurso REST: v1.projects

Métodos
accounts POST /v1/projects/{targetProjectId}/accounts
Registra um novo usuário ou usuário anônimo com e-mail e senha ou faz upgrade de um usuário anônimo para e-mail e senha.
createSessionCookie POST /v1/projects/{targetProjectId}:createSessionCookie
Cria um cookie de sessão para o token de ID do Identity Platform fornecido.
queryAccounts POST /v1/projects/{targetProjectId}:queryAccounts
Procura contas de usuário em um projeto ou locatário com base nas condições da solicitação.

Recurso REST: v1.projects.accounts

Métodos
batchCreate POST /v1/projects/{targetProjectId}/accounts:batchCreate
Faz o upload de várias contas no projeto do Google Cloud.
batchDelete POST /v1/projects/{targetProjectId}/accounts:batchDelete
Exclui várias contas em lote.
batchGet GET /v1/projects/{targetProjectId}/accounts:batchGet
Faça o download das informações de todas as contas do projeto de forma paginada.
delete POST /v1/projects/{targetProjectId}/accounts:delete
Exclui a conta de um usuário.
lookup POST /v1/projects/{targetProjectId}/accounts:lookup
Recebe informações de todas as contas correspondentes.
query POST /v1/projects/{targetProjectId}/accounts:query
Procura contas de usuário em um projeto ou locatário com base nas condições da solicitação.
sendOobCode POST /v1/projects/{targetProjectId}/accounts:sendOobCode
Envia um código de confirmação externo para uma conta.
update POST /v1/projects/{targetProjectId}/accounts:update
Atualiza as informações relacionadas à conta do usuário especificado definindo campos específicos ou aplicando códigos de ação.

Recurso REST: v1.projects.tenants

Métodos
accounts POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts
Registra um novo usuário ou usuário anônimo com e-mail e senha ou faz upgrade de um usuário anônimo para e-mail e senha.
createSessionCookie POST /v1/projects/{targetProjectId}/tenants/{tenantId}:createSessionCookie
Cria um cookie de sessão para o token de ID do Identity Platform fornecido.

Recurso REST: v1.projects.tenants.accounts

Métodos
batchCreate POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:batchCreate
Faz o upload de várias contas no projeto do Google Cloud.
batchDelete POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:batchDelete
Exclui várias contas em lote.
batchGet GET /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:batchGet
Faça o download das informações de todas as contas do projeto de forma paginada.
delete POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:delete
Exclui a conta de um usuário.
lookup POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:lookup
Recebe informações de todas as contas correspondentes.
query POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:query
Procura contas de usuário em um projeto ou locatário com base nas condições da solicitação.
sendOobCode POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:sendOobCode
Envia um código de confirmação externo para uma conta.
update POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:update
Atualiza as informações relacionadas à conta do usuário especificado definindo campos específicos ou aplicando códigos de ação.