Identity Toolkit API

借助 Google Identity Toolkit API，您可以使用开放式标准来验证用户的身份。

服务：identitytoolkit.googleapis.com

如要调用此服务，我们建议您使用 Google 提供的客户端库。如果您的应用需要使用您自己的库来调用此服务，则在发出 API 请求时应使用以下信息。

发现文档

发现文档是用于说明和使用 REST API 的机器可读规范。它用于构建客户端库、IDE 插件以及与 Google API 交互的其他工具。一项服务可能会提供多个发现文档。此服务提供了以下发现文档：

服务端点

服务端点是指定 API 服务的网络地址的基本网址。一项服务可能有多个服务端点。此服务具有以下服务端点，下面的所有 URI 都与此服务端点相关：

  • https://identitytoolkit.googleapis.com

REST 资源：v2

方法
getPasswordPolicy GET /v2/passwordPolicy
获取在项目或租户上设置的密码政策配置。
getRecaptchaConfig GET /v2/recaptchaConfig
获取 reCAPTCHA 分析所需的参数。

REST 资源：v2.accounts

方法
revokeToken POST /v2/accounts:revokeToken
从身份提供方 (IdP) 撤消用户的令牌。

REST 资源：v2.accounts.mfaEnrollment

方法
finalize POST /v2/accounts/mfaEnrollment:finalize
为用户完成注册第二重身份验证。
start POST /v2/accounts/mfaEnrollment:start
MFA 注册流程的第一步。
withdraw POST /v2/accounts/mfaEnrollment:withdraw
撤消账号已注册的第二重身份验证中的一项。

REST 资源：v2.accounts.mfaSignIn

方法
finalize POST /v2/accounts/mfaSignIn:finalize
验证 MFA 质询并执行登录
start POST /v2/accounts/mfaSignIn:start
发送 MFA 质询

REST 资源：v2.defaultSupportedIdps

方法
list GET /admin/v2/defaultSupportedIdps
列出所有默认支持的 IDP。

REST 资源：v2.projects

方法
getConfig GET /admin/v2/{name=projects/*/config}
检索 Identity Toolkit 项目配置。
updateConfig PATCH /admin/v2/{config.name=projects/*/config}
更新 Identity Toolkit 项目配置。

REST 资源：v2.projects.defaultSupportedIdpConfigs

方法
create POST /admin/v2/{parent=projects/*}/defaultSupportedIdpConfigs
为 Identity Toolkit 项目创建默认的受支持 Idp 配置。
delete DELETE /admin/v2/{name=projects/*/defaultSupportedIdpConfigs/*}
删除 Identity Toolkit 项目的默认受支持 IdP 配置。
get GET /admin/v2/{name=projects/*/defaultSupportedIdpConfigs/*}
为 Identity Toolkit 项目检索默认受支持的 Idp 配置。
list GET /admin/v2/{parent=projects/*}/defaultSupportedIdpConfigs
列出 Identity Toolkit 项目支持的所有默认 IDP 配置。
patch PATCH /admin/v2/{defaultSupportedIdpConfig.name=projects/*/defaultSupportedIdpConfigs/*}
更新 Identity Toolkit 项目的默认受支持 IdP 配置。

REST 资源：v2.projects.domain

方法
verify POST /admin/v2/{resource=projects/*}/domain:verify
验证请求的自定义网域是否具有所需的 DNS 记录。

REST 资源：v2.projects.identityPlatform

方法
initializeAuth POST /v2/{project=projects/*}/identityPlatform:initializeAuth
为 Cloud 项目初始化 Identity Platform。

REST 资源：v2.projects.inboundSamlConfigs

方法
create POST /admin/v2/{parent=projects/*}/inboundSamlConfigs
为 Identity Toolkit 项目创建入站 SAML 配置。
delete DELETE /admin/v2/{name=projects/*/inboundSamlConfigs/*}
删除 Identity Toolkit 项目的入站 SAML 配置。
get GET /admin/v2/{name=projects/*/inboundSamlConfigs/*}
检索 Identity Toolkit 项目的入站 SAML 配置。
list GET /admin/v2/{parent=projects/*}/inboundSamlConfigs
列出 Identity Toolkit 项目的所有入站 SAML 配置。
patch PATCH /admin/v2/{inboundSamlConfig.name=projects/*/inboundSamlConfigs/*}
更新 Identity Toolkit 项目的入站 SAML 配置。

REST 资源：v2.projects.oauthIdpConfigs

方法
create POST /admin/v2/{parent=projects/*}/oauthIdpConfigs
为 Identity Toolkit 项目创建 Oidc Idp 配置。
delete DELETE /admin/v2/{name=projects/*/oauthIdpConfigs/*}
删除 Identity Toolkit 项目的 OIDC Idp 配置。
get GET /admin/v2/{name=projects/*/oauthIdpConfigs/*}
检索 Identity Toolkit 项目的 Oidc Idp 配置。
list GET /admin/v2/{parent=projects/*}/oauthIdpConfigs
列出 Identity Toolkit 项目的所有 Oidc Idp 配置。
patch PATCH /admin/v2/{oauthIdpConfig.name=projects/*/oauthIdpConfigs/*}
更新 Identity Toolkit 项目的 OIDC Idp 配置。

REST 资源：v2.projects.tenants

方法
create POST /v2/{parent=projects/*}/tenants
创建租户。
delete DELETE /v2/{name=projects/*/tenants/*}
删除租户。
get GET /v2/{name=projects/*/tenants/*}
获取租户。
getIamPolicy POST /admin/v2/{resource=projects/*/tenants/*}:getIamPolicy
获取资源的访问权限控制政策。
list GET /v2/{parent=projects/*}/tenants
列出给定代理项目下的租户。
patch PATCH /v2/{tenant.name=projects/*/tenants/*}
更新租户。
setIamPolicy POST /admin/v2/{resource=projects/*/tenants/*}:setIamPolicy
规定获取资源的访问权限控制政策。
testIamPermissions POST /admin/v2/{resource=projects/*/tenants/*}:testIamPermissions
返回调用者对资源的权限。

REST 资源：v2.projects.tenants.defaultSupportedIdpConfigs

方法
create POST /v2/{parent=projects/*/tenants/*}/defaultSupportedIdpConfigs
为 Identity Toolkit 项目创建默认的受支持 Idp 配置。
delete DELETE /v2/{name=projects/*/tenants/*/defaultSupportedIdpConfigs/*}
删除 Identity Toolkit 项目的默认受支持 IdP 配置。
get GET /v2/{name=projects/*/tenants/*/defaultSupportedIdpConfigs/*}
为 Identity Toolkit 项目检索默认受支持的 Idp 配置。
list GET /v2/{parent=projects/*/tenants/*}/defaultSupportedIdpConfigs
列出 Identity Toolkit 项目支持的所有默认 IDP 配置。
patch PATCH /v2/{defaultSupportedIdpConfig.name=projects/*/tenants/*/defaultSupportedIdpConfigs/*}
更新 Identity Toolkit 项目的默认受支持 IdP 配置。

REST 资源：v2.projects.tenants.domain

方法
verify POST /admin/v2/{resource=projects/*/tenants/*}/domain:verify
验证请求的自定义网域是否具有所需的 DNS 记录。

REST 资源：v2.projects.tenants.inboundSamlConfigs

方法
create POST /v2/{parent=projects/*/tenants/*}/inboundSamlConfigs
为 Identity Toolkit 项目创建入站 SAML 配置。
delete DELETE /v2/{name=projects/*/tenants/*/inboundSamlConfigs/*}
删除 Identity Toolkit 项目的入站 SAML 配置。
get GET /v2/{name=projects/*/tenants/*/inboundSamlConfigs/*}
检索 Identity Toolkit 项目的入站 SAML 配置。
list GET /v2/{parent=projects/*/tenants/*}/inboundSamlConfigs
列出 Identity Toolkit 项目的所有入站 SAML 配置。
patch PATCH /v2/{inboundSamlConfig.name=projects/*/tenants/*/inboundSamlConfigs/*}
更新 Identity Toolkit 项目的入站 SAML 配置。

REST 资源：v2.projects.tenants.oauthIdpConfigs

方法
create POST /v2/{parent=projects/*/tenants/*}/oauthIdpConfigs
为 Identity Toolkit 项目创建 Oidc Idp 配置。
delete DELETE /v2/{name=projects/*/tenants/*/oauthIdpConfigs/*}
删除 Identity Toolkit 项目的 OIDC Idp 配置。
get GET /v2/{name=projects/*/tenants/*/oauthIdpConfigs/*}
检索 Identity Toolkit 项目的 Oidc Idp 配置。
list GET /v2/{parent=projects/*/tenants/*}/oauthIdpConfigs
列出 Identity Toolkit 项目的所有 Oidc Idp 配置。
patch PATCH /v2/{oauthIdpConfig.name=projects/*/tenants/*/oauthIdpConfigs/*}
更新 Identity Toolkit 项目的 OIDC Idp 配置。

REST 资源：v1

方法
getProjects GET /v1/projects
获取项目的公开 Identity Toolkit 配置。
getPublicKeys GET /v1/publicKeys
检索旧版 Identity Toolkit 令牌签名者的公钥，以便第三方验证旧版 ID 令牌。
getRecaptchaParams GET /v1/recaptchaParams
获取生成 reCAPTCHA 验证码所需的参数。
getSessionCookiePublicKeys GET /v1/sessionCookiePublicKeys
检索会话 Cookie JSON Web 令牌 (JWT) signer 的一组公钥，这些公钥可用于验证通过 createSessionCookie 创建的会话 Cookie。

REST 资源：v1.accounts

方法
createAuthUri POST /v1/accounts:createAuthUri
如果指定了电子邮件标识符，则检查并返回是否有任何用户账号使用该电子邮件地址注册。
delete POST /v1/accounts:delete
删除用户的账号。
issueSamlResponse POST /v1/accounts:issueSamlResponse
实验性
lookup POST /v1/accounts:lookup
获取所有匹配账号的账号信息。
resetPassword POST /v1/accounts:resetPassword
重置账号的密码，方法是使用 sendOobCode 生成的带外代码，或指定要修改的账号的电子邮件地址和密码。
sendOobCode POST /v1/accounts:sendOobCode
为账号发送非对称确认码。
sendVerificationCode POST /v1/accounts:sendVerificationCode
发送电话号码登录的短信验证码。
signInWithCustomToken POST /v1/accounts:signInWithCustomToken
通过交换自定义 Auth 令牌来登录或注册用户。
signInWithEmailLink POST /v1/accounts:signInWithEmailLink
使用电子邮件链接中的非现场验证码登录或注册用户。
signInWithGameCenter POST /v1/accounts:signInWithGameCenter
使用 iOS Game Center 凭据登录或注册用户。
signInWithIdp POST /v1/accounts:signInWithIdp
使用身份提供方 (IdP) 的凭据登录或注册用户。
signInWithPassword POST /v1/accounts:signInWithPassword
使用电子邮件和密码登录用户。
signInWithPhoneNumber POST /v1/accounts:signInWithPhoneNumber
完成电话号码身份验证尝试。
signUp POST /v1/accounts:signUp
注册新的电子邮件和密码用户或匿名用户，或将匿名用户升级为电子邮件和密码用户。
update POST /v1/accounts:update
通过设置特定字段或应用操作代码，更新指定用户的账号相关信息。
verifyIosClient POST /v1/accounts:verifyIosClient
验证 iOS 客户端是否为真实的 iOS 设备。

REST 资源：v1.projects

方法
accounts POST /v1/projects/{targetProjectId}/accounts
注册新的电子邮件和密码用户或匿名用户，或将匿名用户升级为电子邮件和密码用户。
createSessionCookie POST /v1/projects/{targetProjectId}:createSessionCookie
为给定的 Identity Platform ID 令牌创建会话 Cookie。
queryAccounts POST /v1/projects/{targetProjectId}:queryAccounts
根据请求中的条件在项目或租户中查找用户账号。

REST 资源：v1.projects.accounts

方法
batchCreate POST /v1/projects/{targetProjectId}/accounts:batchCreate
将多个账号上传到 Google Cloud 项目。
batchDelete POST /v1/projects/{targetProjectId}/accounts:batchDelete
批量删除多个账号。
batchGet GET /v1/projects/{targetProjectId}/accounts:batchGet
以分页方式下载项目中所有账号的账号信息。
delete POST /v1/projects/{targetProjectId}/accounts:delete
删除用户的账号。
lookup POST /v1/projects/{targetProjectId}/accounts:lookup
获取所有匹配账号的账号信息。
query POST /v1/projects/{targetProjectId}/accounts:query
根据请求中的条件在项目或租户中查找用户账号。
sendOobCode POST /v1/projects/{targetProjectId}/accounts:sendOobCode
为账号发送非对称确认码。
update POST /v1/projects/{targetProjectId}/accounts:update
通过设置特定字段或应用操作代码，更新指定用户的账号相关信息。

REST 资源：v1.projects.tenants

方法
accounts POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts
注册新的电子邮件和密码用户或匿名用户，或将匿名用户升级为电子邮件和密码用户。
createSessionCookie POST /v1/projects/{targetProjectId}/tenants/{tenantId}:createSessionCookie
为给定的 Identity Platform ID 令牌创建会话 Cookie。

REST 资源：v1.projects.tenants.accounts

方法
batchCreate POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:batchCreate
将多个账号上传到 Google Cloud 项目。
batchDelete POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:batchDelete
批量删除多个账号。
batchGet GET /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:batchGet
以分页方式下载项目中所有账号的账号信息。
delete POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:delete
删除用户的账号。
lookup POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:lookup
获取所有匹配账号的账号信息。
query POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:query
根据请求中的条件在项目或租户中查找用户账号。
sendOobCode POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:sendOobCode
为账号发送非对称确认码。
update POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:update
通过设置特定字段或应用操作代码，更新指定用户的账号相关信息。