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
從 Identity Provider (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
傳送多重驗證挑戰

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
擷取舊版身分識別工具符記簽署者的公開金鑰，讓第三方驗證舊版 ID 權杖。
getRecaptchaParams GET /v1/recaptchaParams
取得產生 reCAPTCHA 驗證問題所需的參數。
getSessionCookiePublicKeys GET /v1/sessionCookiePublicKeys
擷取會話 Cookie JSON Web Token (JWT) 簽署者的公開金鑰組合，可用於驗證透過 createSessionCookie 建立的會話 Cookie。

REST 資源：v1.accounts

方法
createAuthUri POST /v1/accounts:createAuthUri
如果指定電子郵件 ID，系統會檢查並傳回是否有任何使用者帳戶已使用該電子郵件註冊。
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
透過交換自訂驗證權杖，登入或註冊使用者。
signInWithEmailLink POST /v1/accounts:signInWithEmailLink
使用電子郵件連結中的額外代碼，為使用者登入或註冊。
signInWithGameCenter POST /v1/accounts:signInWithGameCenter
使用 iOS Game Center 憑證登入或註冊使用者。
signInWithIdp POST /v1/accounts:signInWithIdp
使用來自 Identity Provider (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
透過設定特定欄位或套用動作代碼，更新指定使用者的帳戶相關資訊。