Identity Toolkit API

Google Identity Toolkit API を使用すると、オープンな標準規格を使用してユーザーの ID を確認できます。

サービス: identitytoolkit.googleapis.com

このサービスを呼び出すには、Google が提供するクライアント ライブラリを使用することをおすすめします。アプリケーションで独自のライブラリを使用してこのサービスを呼び出す必要がある場合は、API リクエストの際に次の情報を使用してください。

ディスカバリ ドキュメント

ディスカバリ ドキュメントは、REST API を記述して使用するための機械可読仕様です。クライアント ライブラリ、IDE プラグイン、Google API と連携するその他のツールのビルドに使用されます。1 つのサービスで複数のディスカバリ ドキュメントを提供できます。このサービスには、次のディスカバリ ドキュメントが用意されています。

サービス エンドポイント

サービス エンドポイントは、API サービスのネットワーク アドレスを指定するベース URL です。1 つのサービスに複数のサービス エンドポイントが存在することもあります。このサービスには次のサービス エンドポイントがあり、以下のすべての URI がこのサービス エンドポイントに関連しています。

  • https://identitytoolkit.googleapis.com

REST リソース: v2

メソッド
getPasswordPolicy GET /v2/passwordPolicy
プロジェクトまたはテナントで設定されたパスワード ポリシー構成を取得します。
getRecaptchaConfig GET /v2/recaptchaConfig
reCAPTCHA 分析に必要なパラメータを取得します。

REST リソース: v2.accounts

メソッド
revokeToken POST /v2/accounts:revokeToken
ユーザーのトークンを ID プロバイダ（IdP）から取り消します。

REST リソース: v2.accounts.mfaEnrollment

メソッド
finalize POST /v2/accounts/mfaEnrollment:finalize
ユーザーの第 2 要素の登録が完了します。
start POST /v2/accounts/mfaEnrollment:start
多要素認証の登録プロセスのステップ 1。
withdraw POST /v2/accounts/mfaEnrollment:withdraw
アカウントに登録されている第 2 要素から 1 つの第 2 要素を取り消します。

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
createSessionCookie で作成されたセッション クッキーの検証に使用できる、セッション クッキー JSON Web Token（JWT）署名者の公開鍵のセットを取得します。

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
電話番号でのログイン用の SMS 確認コードを送信します。
signInWithCustomToken POST /v1/accounts:signInWithCustomToken
カスタム認証トークンを交換して、ユーザーをログインまたは登録します。
signInWithEmailLink POST /v1/accounts:signInWithEmailLink
メールのリンクに記載された帯域外のコードを使用してユーザーをログインまたは登録します。
signInWithGameCenter POST /v1/accounts:signInWithGameCenter
iOS Game Center の認証情報を使用してユーザーをログインまたは登録します。
signInWithIdp POST /v1/accounts:signInWithIdp
ID プロバイダ（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
特定のフィールドを設定するか、アクション コードを適用して、指定したユーザーのアカウント関連情報を更新します。