Package google.cloud.identitytoolkit.v1

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

int32

必須。目的のハッシュの長さ（バイト単位）。最小値は 4、最大値は 1,024 です。

HashType

必須。HASH_TYPE_UNSPECIFIED にすることはできません。

int32

必須。並列処理の程度（スレッドまたはレーンとも呼ばれます）。最小値は 1、最大値は 16 です。

int32

必須。実行する反復処理の数。最小値は 1、最大値は 16 です。

int32

必須。メモリコスト（キビバイト単位）。最大値は 32,768 です。

Version

Argon2 アルゴリズムのバージョン。指定しない場合のデフォルトは VERSION_13 です。

bytes

関連付けられる追加データ（指定されている場合）は、追加のセキュリティ レイヤを挿入するためにハッシュ値に付加されます。JSON で指定した場合は、Base64 でエンコードされた文字列。

string

tenant_id が指定されている場合、Identity Platform テナントが属する Google Cloud プロジェクトの ID。それ以外の場合は、アカウントが属する Google Cloud プロジェクトの ID。

認可には、指定されたリソース targetProjectId に対する次の IAM の権限が必要です。

• firebaseauth.users.delete

string

必須。削除するユーザー ID のリスト。

bool

無効な状態ではないアカウントを強制的に削除するかどうか。false の場合、無効なアカウントのみが削除され、無効でないアカウントは errors に追加されます。

string

アカウントが Identity Platform テナントに属している場合は、テナントの ID。アカウントがデフォルトの Identity Platform プロジェクトに属している場合、このフィールドは必要ありません。

BatchDeleteErrorInfo

削除できないアカウントに関する詳細なエラー情報。

int32

元の local_ids フィールド内のエラーのあるアイテムのインデックス。

string

対応するユーザー ID。

string

詳細なエラー メッセージ。

string

関連付けられたプロバイダを取得するユーザー アカウントのメール ID。identifier フィールドと provider_id フィールドの少なくとも 1 つを設定する必要があります。

メールアドレスの長さは 256 文字未満で、name@domain.tld の形式にする必要があります。メールアドレスは、RFC 822 addr-spec 本番環境と一致している必要があります。

string

IDP がユーザーをリダイレクトする有効な URL。URL にフラグメントや予約済みの state クエリ パラメータを含めることはできません。

string

string

ユーザーがログインする IdP のプロバイダ ID。これは、ログイン用に有効になっているプロバイダ ID である必要があります。これは、デフォルトでサポートされている IdP のリストから選択するか、oidc.* または saml.* の形式で指定します。たとえば、google.com、facebook.com、oidc.testapp、saml.testapp などです。identifier フィールドと provider_id フィールドの少なくとも 1 つを設定する必要があります。

string

string

IdP との認証リクエストのスコープを指定する、スペース区切りの追加の OAuth 2.0 スコープ。OAuth 2.0 IdP に使用。

Google プロバイダの場合、このフィールドが設定されていると、認証コードフローを使用します。

string

認証リクエストと IdP からのコールバック間のコンテキスト情報を維持するために使用される不透明な文字列。

string

string

string

Google プロバイダに使用されます。ユーザーの G Suite ホストドメイン（そのドメインのユーザーにログインを制限するため）。

string

セッション固定攻撃を防ぐために、SignInWithIdp で検証できるセッション ID。指定しない場合、ランダムな文字列が生成され、セッション ID として返されます。

string

Google プロバイダに使用されます。使用する認証フローのタイプ。存在する場合は、認証コードフローを指定するために CODE_FLOW にする必要があります。それ以外の場合は、デフォルトの ID トークン フローが使用されます。

map<string, string>

認可 URI に追加する追加のカスタマイズされたクエリ パラメータ。次のパラメータは予約済みであり、追加できません。client_id、response_type、scope、redirect_uri、state。

Microsoft プロバイダの場合、ログインする Azure AD テナントは tenant カスタム パラメータで指定できます。

string

承認 URI の作成またはメール ID の検索を行う Identity Platform テナントの ID。設定しない場合、オペレーションはプロジェクトのデフォルトの Identity Platform インスタンスで実行されます。

string

string

リクエストされたプロバイダの認可 URI。リクエストでプロバイダ ID が設定されている場合にのみ存在します。

string

bool

メール ID が既存のアカウントを表すかどうか。リクエストでメール ID が設定されている場合にのみ存在します。

string

リクエストのプロバイダ ID（指定されている場合）。

bool

ユーザーがリクエストのプロバイダ ID で以前にログインしたことがあるかどうか。リクエストで登録済みのメール ID が設定されている場合にのみ存在します。

bool

ユーザーによるログイン試行が過度に多いために CAPTCHA が必要かどうか。登録済みのメール識別子がリクエストで設定されている場合にのみ存在します。

string

リクエストのセッション ID。リクエストにセッション ID がない場合、CreateAuthUri によって生成されたランダムな文字列。セッション修正攻撃を防ぐために使用されます。

string

ユーザーが以前に使用したログイン方法のリスト。各要素は、password、emailLink、または IdP のプロバイダ ID のいずれかです。リクエストで登録済みのメール ID が設定されている場合にのみ存在します。メール列挙保護が有効になっている場合、このメソッドは空のリストを返します。

string

必須。有効な Identity Platform ID トークン。

int64

セッション Cookie の有効期限が切れるまでの秒数。期間を秒単位で指定します。5 分～ 14 日の範囲で指定できます。

string

アカウントが属するプロジェクトの ID。

string

アカウントが属する Identity Platform テナントのテナント ID。

string

リクエストで指定された Identity Platform ID トークンから作成されたセッション Cookie。JSON Web Token（JWT）の形式です。常に存在します。

string

削除するユーザー アカウントの ID。このフィールドを指定する場合は、適切な権限を持つ Google OAuth 2.0 認証情報が必要です。認証情報のないユーザーからのリクエストには、代わりに ID トークンを渡す必要があります。

int64

string

削除するアカウントの Identity Platform ID トークン。Google OAuth 2.0 認証情報のないエンドユーザーからのリクエストには指定する必要があります。適切な権限を持つ Google OAuth2 認証情報を使用した認証済みリクエストでは、local_id を渡して削除するアカウントを指定することもできます。

string

アカウントが属するテナントの ID（該当する場合）。Identity Platform テナントに属するアカウントの local_id を指定する Google OAuth 2.0 認証情報を含む認証済みリクエストでのみ指定する必要があります。

string

アカウントが属するプロジェクトの ID。アカウントの local_id を指定する認証済みリクエストでのみ指定する必要があります。

認可には、指定されたリソース targetProjectId に対する次の IAM の権限が必要です。

• firebaseauth.users.delete

string

int64

string

前のリクエストのレスポンスのページ設定トークン。

int32

返される結果の最大件数です。1 ～ 1,000 にする必要があります。デフォルトでは 20 です。

string

tenant_id が指定されている場合、Identity Platform テナントが属する Google Cloud プロジェクトの ID。それ以外の場合は、アカウントが属する Google Cloud プロジェクトの ID です。

認可には、指定されたリソース targetProjectId に対する次の IAM の権限が必要です。

• firebaseauth.users.get

string

アカウントが属する Identity Platform テナントの ID。指定しない場合、Identity Platform プロジェクトのアカウントが返されます。

string

UserInfo

リクエストの max_results で制限される、プロジェクト/テナントに属するすべてのアカウント。

string

ダウンロードするアカウントが他にもある場合は、DownloadAccount に渡して他のアカウントを取得できるトークン。それ以外の場合は空白です。

string

MFA の確認を送信するメールアドレス。

bool

テンプレートが無効かどうか。true の場合、デフォルトのテンプレートが使用されます。

string

メールの送信元アドレス

string

メールの本文

string

メールの件名

string

表示名から

EmailBodyFormat

メール本文の形式

string

返信先アドレス

string

送信元アドレスのローカル部分

string

値は III 言語コード形式です（例: zh-CN、es）。区切り文字には「-」と「_」の両方を使用できます。

bool

メールの本文または件名がカスタマイズされているかどうか。

int32

アイテムのインデックス。範囲は [0, request.size - 1]

string

詳細なエラー メッセージ

string

取得するアカウントの Identity Platform ID トークン。エンドユーザーからのリクエストで指定する必要があります。

string

取得する 1 つ以上のアカウントの ID。適切な権限を持つ Google OAuth 2.0 認証情報を含む認証済みリクエストでのみ指定する必要があります。

string

取得する 1 つ以上のアカウントのメールアドレス。メールアドレスは 256 文字未満で、name@domain.tld の形式にする必要があります。また、メールは RFC 822 の addr-spec 本番環境と一致している必要があります。デベロッパーからの認証済みリクエストによってのみ指定する必要があります。

int64

string

取得する 1 つ以上のアカウントの電話番号。デベロッパーからの認証済みリクエストでのみ指定し、E.164 形式（+15555555555 など）で指定する必要があります。

FederatedUserIdentifier

string

アカウントが属するテナントの ID。デベロッパーからの認証済みリクエストによってのみ指定する必要があります。

string

tenant_id で指定されたアカウントまたは Identity Platform テナントが属する Google Cloud プロジェクトの ID。適切な権限を持つ Google OAuth 2.0 認証情報を含む認証済みリクエストでのみ指定する必要があります。

認可には、指定されたリソース targetProjectId に対する次の IAM の権限が必要です。

• firebaseauth.users.get

string

取得する 1 つ以上のアカウントの最初のメールアドレス。メールアドレスは 256 文字未満で、name@domain.tld の形式にする必要があります。また、メールは RFC 822 の addr-spec 本番環境と一致している必要があります。デベロッパーからの認証済みリクエストによってのみ指定する必要があります。

string

サポートされている ID プロバイダの ID。これは、ログイン用に有効になっているプロバイダ ID である必要があります。これは、デフォルトでサポートされている IdP のリストから選択するか、oidc.* または saml.* の形式で指定します。たとえば、google.com、facebook.com、oidc.testapp、saml.testapp などです。

string

provider_id で指定されたサードパーティ ID プロバイダのアカウントのユーザー ID。

string

UserInfo

リクエストのパラメータに一致する特定のユーザー アカウントの情報。

OobReqType

必須。送信するアウトオブバンド（OOB）コードのタイプ。この値に応じて、このリクエストの他のフィールドが必須になるか、意味が異なる場合があります。送信できる OOB コードは 4 種類あります。* PASSWORD_RESET * EMAIL_SIGNIN * VERIFY_EMAIL * VERIFY_AND_CHANGE_EMAIL

string

OOB コードを送信するアカウントのメールアドレス。通常は、更新が必要なアカウントのメールアドレスです。PASSWORD_RESET、EMAIL_SIGNIN、VERIFY_EMAIL に必要です。return_oob_link が true に設定されている場合の VERIFY_AND_CHANGE_EMAIL リクエストでのみ必要です。この場合は、ユーザーの元のメールアドレスです。

string

string

PASSWORD_RESET リクエストの場合、不正使用の可能性があるアクティビティがシステムで検出されると、reCaptcha レスポンスが必要になります。この場合、これは呼び出し元の確認に使用される reCaptcha チャレンジからのレスポンスです。

string

呼び出し元の IP アドレス。PASSWORD_RESET リクエストでのみ必要です。

string

アカウントの更新先のメールアドレス。VERIFY_AND_CHANGE_EMAIL リクエストでのみ必須です。

string

アカウントの ID トークン。return_oob_link が true に設定されていない限り、VERIFY_AND_CHANGE_EMAIL リクエストと VERIFY_EMAIL リクエストで必須です。

string

ユーザーがメールで送信されたリンクをクリックした後に続行する URL。ウェブ ウィジェットが OOB コードを処理できるようにする URL です。

string

関連付けられた iOS アプリが OOB コードを処理できる場合は、このアプリの iOS バンドル ID。これにより、正しいアプリがすでにインストールされている場合は、そのアプリが開きます。

string

関連付けられた iOS アプリが OOB コードを処理できる場合は、そのアプリの App Store ID。これにより、アプリがまだインストールされていない場合に、App Store で正しいアプリを開くことができます。

string

関連付けられた Android アプリが OOB コードを処理できる場合は、この OOB コードが使用されたときにコールバックを処理する Android アプリの Android パッケージ名。これにより、正しいアプリがすでにインストールされている場合はそのアプリが開き、まだインストールされていない場合は Google Play ストアが開いて正しいアプリが表示されます。

bool

関連付けられた Android アプリが OOB コードを処理できるかどうか、リンクが開かれたデバイスに Android アプリがまだインストールされていない場合に Android アプリをインストールするかどうか。

string

関連付けられている Android アプリが OOB コードを処理できる場合は、アプリの最小バージョン。デバイスのバージョンがこのバージョンより低い場合、ユーザーは Google Play ストアにリダイレクトされ、アプリのアップグレードを促されます。

bool

true に設定すると、OOB コード リンクはユニバーサル リンクまたは Android アプリリンクとして送信され、対応するアプリがインストールされている場合はそのアプリで開かれます。未設定または false に設定されている場合、OOB コードは最初にウェブ ウィジェットに送信され、続いてアプリがインストールされている場合はそのアプリにリダイレクトされます。

string

アカウントが属する Identity Platform テナントのテナント ID。

string

アカウントが属する Identity Platform プロジェクトのプロジェクト ID。このフィールドを指定するには、適切な権限を持つ Google OAuth 2.0 認証情報が必要です。

認可には、指定されたリソース targetProjectId に対する次の IAM の権限が必要です。

• firebaseauth.users.sendEmail

string

使用した URL を iOS または Android で簡単に開けるように、Firebase Dynamic Links を作成します。ほとんどの Identity Platform プロジェクトでは、有効にするダイナミック リンク ドメインは 1 つだけであるため、このフィールドは空白のままにできます。このフィールドには、複数の Dynamic Links が有効になっているプロジェクトに指定された Dynamic Links ドメインが含まれます。

bool

OOB コードを含む確認リンクをレスポンスで返すかどうか（メールは送信されません）。デベロッパーがメール テンプレートを作成して独自に送信する場合に使用します。デフォルトでは false です。このフィールドを指定して true に設定するには、適切な権限を持つ Google OAuth 2.0 認証情報が必要です。

ClientType

クライアントの種類: ウェブ、Android、iOS。reCAPTCHA Enterprise 保護が有効になっている場合に必要です。

RecaptchaVersion

captcha_response 内の reCAPTCHA トークンの reCAPTCHA バージョン。

string

省略可。使用している URL を iOS または Android で簡単に開けるようにするため、ホスティング リンク「/__/auth/links」を作成します。このオプション フィールドには、Hosting リンクの作成時に使用するドメインを指定します。設定しない場合、.firebaseapp.com ドメインが使用されます。

string

string

リクエストで return_oob_link が true の場合、送信する OOB コード。

string

リクエストで return_oob_link が false の場合、確認が送信されたメールアドレス。

string

リクエストで return_oob_link が true の場合、ユーザーに送信される OOB リンク。これにより、Firebase Dynamic Links 関連のパラメータを含む、作成されたリンクが返されます。

int64

委任されたプロジェクト リクエストのプロジェクト番号。このフィールドは、Firebase V1 の移行の一環としてのみ使用してください。

int64

取得する構成のプロジェクト番号。このフィールドは非推奨です。新しい統合では使用しないでください。

bool

ダイナミック リンクを返すかどうか。

string

実際の Android パッケージ名と照合する Android パッケージ名。このフィールドが指定され、sha1_cert_hash が指定されていない場合、これが実際の Android パッケージ名と一致しない場合、アクションはエラーをスローします。

string

実際の iOS バンドル ID と照合する iOS バンドル ID。このフィールドが指定されている場合、実際の iOS バンドル ID と一致しない場合、アクションはエラーをスローします。

string

RP OAuth クライアント ID。設定されている場合、OAuth クライアントが取得したプロジェクトに対して有効であることを確認するチェックが行われ、有効でない場合、リクエストはクライアント エラーで拒否されます。

string

SHA-1 Android アプリケーション証明書ハッシュ。設定されている場合、取得したプロジェクトと android_package_name に対して証明書ハッシュが有効であることを確認するチェックが実行されます。

string

Firebase アプリ ID（Firebase を使用するアプリの場合）。これは、プロジェクトの Firebase コンソールで確認できます。設定されている場合、取得したプロジェクトに対してアプリ ID が有効であることを確認するチェックが行われます。有効でない場合、リクエストはクライアント エラーで拒否されます。

string

取得した構成のプロジェクト ID。

string

Google Cloud API キー。このフィールドは、デベロッパーからの認証済み呼び出しでのみ返されます。

bool

パスワード アカウントの登録を許可するかどうか。このフィールドは、デベロッパーからの認証済み呼び出しでのみ返されます。

IdpConfig

OAuth2 プロバイダの構成。このフィールドは、デベロッパーからの認証済み呼び出しでのみ返されます。

string

ウィジェット リダイレクトの承認済みドメイン。

bool

匿名ユーザーが有効かどうか。このフィールドは、デベロッパーからの認証済み呼び出しでのみ返されます。

string

ネイティブアプリへのリダイレクト用のリンクの作成に使用される Firebase Dynamic Links ドメイン。

bool

メール送信を使用するかどうか。このフィールドは、デベロッパーからの認証済み呼び出しでのみ返されます。

EmailTemplate

パスワードのリセット用のメール テンプレート。このフィールドは、デベロッパーからの認証済み呼び出しでのみ返されます。

EmailTemplate

メール確認用のメール テンプレート。このフィールドは、デベロッパーからの認証済み呼び出しでのみ返されます。

EmailTemplate

メールアドレス変更用のメール テンプレート。このフィールドは、デベロッパーからの認証済み呼び出しでのみ返されます。

EmailTemplate

以前の Firebase V1 アプリのパスワード再設定メール テンプレート。このフィールドは、デベロッパーからの認証済み呼び出しでのみ返されます。

EmailTemplate

第 2 要素の追加を元に戻すためのメール テンプレート。このフィールドは、デベロッパーからの認証済み呼び出しでのみ返されます。

string

string

string

reCAPTCHA サービスを呼び出すために使用される reCAPTCHA v2 サイトキー。常に存在します。

string

PIA トークンの生成に使用されるプロデューサー プロジェクト番号

OpenIdConnectKey

セッション クッキー署名者の公開鍵（JSON Web Key（JWK）形式）。

Provider

bool

ユーザーがプロバイダでログインできるようにする場合は true。

int32

この IdP の連携ログインを求められる/リダイレクトされるユーザーの割合

string

OAuth2 クライアント ID。

string

OAuth2 クライアント シークレット。

string

オーディエンス チェックのホワイトリストに登録されたクライアント ID。

string

リレーリング パーティ ID（発行された SAMLResponse のオーディエンス）。

string

Identity Platform ID トークン。検証された後、新しい SAMLResponse に変換されます。

string

アプリごとに Google 管理コンソールで指定された SAML アプリエンティティ ID。デベロッパーが G Suite アプリではなくサードパーティ製アプリにリダイレクトする場合は、この ID が必要になる可能性があります。使用されると、RelayState が返されます。これには SAMLRequest が含まれます。これは、SP が開始する SAML フローをトリガーして、実際のアプリにリダイレクトするために使用できます。

string

証明書利用者用に作成された署名付き SAMLResponse。

string

返された SAMLResponse を使用する ACS エンドポイント。

string

生成された RelayState。

string

ユーザーのメールアドレス。

string

ユーザーの名（ファースト ネーム）。

string

ユーザーの姓。

bool

ログイン中のユーザーがこのリクエストによって作成されたかどうか。

string

この MFA オプションの ID。

string

この mfa オプションの表示名（例: 「社用携帯電話」）。

Timestamp

アカウントがこの第 2 要素を登録したとき刻。

string

通常、この登録に関連付けられている電話番号が表示されます。最初の要素でログインした後など、関連付けられた電話番号の難読化されたバージョンのみが表示される場合があります。

TotpInfo

TOTP MFA に固有の情報が含まれています。

EmailInfo

メール認証に固有の情報が含まれています。

string

出力専用。難読化されていない phone_info。

string

鍵のタイプ。

string

署名アルゴリズム。

string

鍵の用途。

string

このキーを識別する一意の文字列。

string

RSA 公開鍵のモジュラス。値のビッグ エンディアン表現の base64url エンコードとして表されます。

string

RSA 公開鍵の指数。値のビッグ エンディアン表現の base64url エンコードとして表されます。

string

ID プロバイダの ID。

string

ID プロバイダでのユーザーの表示名。

string

ID プロバイダのユーザーのプロフィール写真の URL。

string

ID プロバイダでのユーザーの ID。

string

ユーザーの ID プロバイダのメールアドレス。

string

ID プロバイダから直接返されたユーザーの未加工 ID。

string

ユーザーの Twitter の screen_name または GitHub のログイン名。

string

ユーザーの ID プロバイダの電話番号。

bool

true の場合、このリクエストはクエリに一致するアカウントを返します。false の場合、クエリに一致するアカウントの数のみが返されます。デフォルトは true です。

int64

返されるアカウントの最大数（上限は 500）。デフォルトは 500 です。return_user_info が true に設定されている場合にのみ有効です。

int64

一致するレコードの先頭からスキップするアカウントの数。return_user_info が true に設定されている場合にのみ有効です。

SortByField

Order

string

結果のスコープに含まれるプロジェクトの ID。

認可には、指定されたリソース targetProjectId に対する次の IAM の権限が必要です。

• firebaseauth.users.get

string

結果のスコープに含まれるテナントの ID。

SqlExpression

string

アカウントのメールアドレスが一致する必要がある大文字と小文字を区別しない文字列。SqlExpression には、email、phone_number、user_id のいずれか 1 つを指定する必要があります。複数指定した場合は、最初の値のみが適用されます。

string

アカウントのローカル ID が一致する文字列。SqlExpression では、email、phone_number、user_id のいずれか 1 つだけを指定する必要があります。複数指定した場合は、最初の値のみが適用されます（順序に従って）。

string

アカウントの電話番号が一致する必要がある文字列。SqlExpression には、email、phone_number、user_id のいずれか 1 つを指定する必要があります。複数指定した場合は、最初の値のみが適用されます。

int64

リクエストの return_user_info が true の場合、このメッセージで返されるアカウントの数です。それ以外の場合は、クエリに一致するアカウントの合計数です。

UserInfo

リクエストの return_user_info が true の場合、これはクエリに一致するアカウントです。

string

GetOobCode リクエストによって生成されたアウトオブバンド（OOB）コード。このパラメータのみ（またはこのパラメータとテナント ID のみ）を指定して、アカウントの状態を変更せずに、レスポンスでアウトオブバンド コードのタイプを取得します。この方法で使用できるのは、PASSWORD_RESET のアウトオブバンド コードのみです。

string

このアカウントに設定する新しいパスワード。このフィールドを指定すると、アカウントが変更され、オフバンド コードが使用されます（指定されている場合、PASSWORD_RESET のタイプ）。

string

変更するアカウントの現在のパスワード。このコードとメールアドレスを指定して、帯域外のコードを使用せずにアカウントのパスワードを変更します。

string

省略可。変更するアカウントのメールアドレス。アウトオブバンド コードを使用せずにアカウントのパスワードを変更するには、このコードと古いパスワードを指定します。

string

省略可。アカウントが属する Identity Platform テナントのテナント ID。

string

string

使用された帯域外のコードに関連付けられているメールアドレス。

string

OobReqType

MfaEnrollment

string

確認コードを送信する電話番号（E.164 形式）。

string

iOS アプリのトークンの検証が成功したことの通知。「captcha_response」が使用されていない場合（reCAPTCHA Enterprise が有効になっていない場合）、確認コードがエミュレータではなく実際のアプリに代わって送信されていることを確認するには、（ios_receipt と ios_secret）、recaptcha_token、または safety_net_token のいずれかを指定する必要があります。これは [verifyIosClient][v1.accounts.verifyIosClient] のレスポンスから取得する必要があります。存在する場合は、呼び出し元は ios_secret と、x-ios-bundle-identifier ヘッダーのバンドル ID も指定する必要があります。このバンドル ID は、[verifyIosClient][v1.accounts.verifyIosClient] リクエストのバンドル ID と一致している必要があります。

string

プッシュ通知として iOS アプリに配信されるシークレット。ios_receipt と x-ios-bundle-identifier ヘッダーとともに渡す必要があります。

string

アプリの確認用の reCAPTCHA トークン。「captcha_response」が使用されていない場合（reCAPTCHA Enterprise が有効になっていない場合）、確認コードがエミュレータではなく実際のアプリに代わって送信されていることを確認するには、（ios_receipt と ios_secret）、recaptcha_token、または safety_net_token のいずれかを指定する必要があります。reCAPTCHA は [getRecaptchaParams][v1.getRecaptchaParams] を呼び出して生成する必要があります。ユーザーが reCAPTCHA のチャレンジを完了すると、reCAPTCHA トークンが生成されます。

string

ユーザーがログインしている Identity Platform テナントのテナント ID。

AutoRetrievalInfo

Android のみ。Google Play 開発者サービスが自動取得するアプリを識別するために使用されます。

string

Android のみ。recaptcha トークンの代わりにアプリケーション ID をアサートするために使用されます。「captcha_response」が使用されていない場合（reCAPTCHA Enterprise が有効になっていない場合）、確認コードがエミュレータではなく実際のアプリに代わって送信されていることを確認するには、（ios_receipt と ios_secret）、recaptcha_token、または safety_net_token のいずれかを指定する必要があります。SafetyNet トークンは、SafetyNet Android Attestation API を使用して生成できます。この場合、phone_number フィールドの Base64 エンコードがノンスとして使用されます。

string

Android のみ。recaptcha トークン（および safety_net_token）の代わりに、アプリケーション ID をアサートするために使用されます。「captcha_response」が使用されていない場合（reCAPTCHA Enterprise が有効になっていない場合）、エミュレータではなく実際のアプリに代わって確認コードが送信されていることを確認するには、（ios_receipt と ios_secret）、recaptcha_token、play_integrity_token のいずれかを指定する必要があります。Play Integrity トークンは、PlayIntegrity API を使用して、phone_number フィールドにノンスとして SHA256 を適用することで生成できます。

string

省略可。reCAPTCHA クライアントサイド統合によって提供される reCAPTCHA Enterprise トークン。reCAPTCHA Enterprise が有効になっている場合は必須です。

ClientType

省略可。クライアントの種類（web、android、ios）。reCAPTCHA Enterprise が有効になっている場合に必須です。

RecaptchaVersion

省略可。captcha_response 内の reCAPTCHA トークンの reCAPTCHA バージョン。reCAPTCHA Enterprise が有効になっている場合に必須です。

string

Google Play 開発者サービスの SMS Retriever API 用の Android アプリの署名ハッシュ。

string

暗号化されたセッション情報。これは、[signInWithPhoneNumber][v1.accounts.signInWithPhoneNumber] で電話番号を認証するために使用できます。

string

有効な Identity Platform ID トークン。ユーザー関連情報を変更する際に必要です。

string

ユーザーの ID。このフィールドを指定する場合は、適切な権限を持つ Google OAuth 2.0 認証情報が必要です。エンドユーザーからのリクエストの場合は、代わりに ID トークンを渡す必要があります。

string

アカウントの属性で更新されるユーザーの新しい表示名。表示名の長さは 256 文字以下にしてください。

string

アカウントの属性で更新されるユーザーの新しいメールアドレス。メールアドレスは 256 文字未満で、name@domain.tld の形式にする必要があります。また、メールは RFC 822 の addr-spec 本番環境と一致している必要があります。メール列挙保護が有効になっている場合、ユーザーはメールを最初に確認しないとメールを変更できませんが、管理者は変更できます。

string

アカウントの属性で更新されるユーザーの新しいパスワード。パスワードは 6 文字以上にしてください。

string

アカウントを関連付ける必要がある ID プロバイダ。

string

ユーザーのアカウントに適用するアウトオブバンド コード。サポートされているアウトオブバンド コードの種類は、* VERIFY_EMAIL * RECOVER_EMAIL * REVERT_SECOND_FACTOR_ADDITION * VERIFY_AND_CHANGE_EMAIL です。

bool

ユーザーのメールアドレスが確認済みかどうか。このフィールドを指定する場合は、適切な権限を持つ Google OAuth 2.0 認証情報が必要です。

bool

アカウントをフェデレーション ログインの使用のみに制限するかどうか。

string

string

reCAPTCHA チャレンジからのレスポンス。これは、不正行為の可能性があるアクティビティがシステムで検出された場合に必要となります。

int64

Identity Platform ID トークンを有効と見なす最小タイムスタンプ（秒単位）を指定します。

bool

true の場合、アカウントが無効としてマークされます。つまり、ユーザーはログインできなくなります。

string

int64

string

アカウントの属性でアカウントのプロフィール写真が更新される、ユーザーの新しい写真 URL。URL の長さは 2,048 文字以下にしてください。

UserAttributeName

bool

ID と更新トークンを返すかどうか。常に true を指定します。

string

ユーザーのアカウントとのリンクを解除する ID プロバイダ。

int64

アカウントが最後にログインしたタイムスタンプ（ミリ秒単位）。

int64

アカウントが作成されたときのタイムスタンプ（ミリ秒単位）。

string

アカウントの属性で更新する電話番号。

string

Identity Platform ID トークンに保存される JSON 形式のカスタム属性。このフィールドを指定するには、適切な権限を持つ Google OAuth 2.0 認証情報が必要です。

string

アカウントが属する Identity Platform テナントのテナント ID。エンドユーザーからのリクエストでは、このフィールドを設定するのではなく、Identity Platform ID トークンを渡す必要があります。

string

アカウントが属するプロジェクトのプロジェクト ID。このフィールドを指定する場合は、適切な権限を持つ Google OAuth 2.0 認証情報が必要です。エンドユーザーからのリクエストでは、代わりに Identity Platform ID トークンを渡す必要があります。

認可には、指定されたリソース targetProjectId に対する次の IAM の権限が必要です。

• firebaseauth.users.update

MfaInfo

ユーザーのアカウントに設定する多要素認証関連情報。これにより、アカウントの以前の多要素認証に関連する情報が上書きされます。このフィールドを指定する場合は、適切な権限を持つ Google OAuth 2.0 認証情報が必要です。

ProviderUserInfo

ユーザーのアカウントにリンクするプロバイダ。このフィールドを指定するには、適切な権限を持つ Google OAuth 2.0 認証情報が必要です。

MfaEnrollment

ユーザーが登録した第 2 要素。

string

string

認証されたユーザーの ID。

string

アカウントのメールアドレス。

string

アカウントの表示名。

string

アカウントの Identity Platform ID トークン。従来のユーザーの登録に使用されます。

ProviderUserInfo

アカウントにリンクされている ID プロバイダ。

string

ユーザーのアカウント属性に設定された新しいメールアドレス。

string

アカウントのプロフィール写真のユーザーの写真の URL。

string

アカウントの更新トークン。従来のユーザーの登録に使用されます。

int64

Identity Platform ID トークンが期限切れになるまでの秒数。

string

非推奨です。現在、実際のパスワード ハッシュは返されません。

bool

アカウントのメールアドレスが確認済みかどうか。

string

必須。デベロッパーがアサートしたカスタム Auth トークン。トークンは、API リファレンスの「カスタム トークン クレーム」セクションに記載されているクレームを含む JSON Web Token（JWT）である必要があります。

string

bool

常に true を指定します。

int64

string

ユーザーがログインしている Identity Platform テナントの ID。存在する場合、ID はトークンの tenant_id と一致している必要があります。

string

string

認証済みユーザーの Identity Platform ID トークン。

string

認証されたユーザーの Identity Platform 更新トークン。

int64

ID トークンの有効期限が切れるまでの秒数。

bool

認証済みユーザーがこのリクエストによって作成されたかどうか。

string

必須。メールのリンクに記載された帯域外のコード。

string

必須。ログイン リンクが送信されたメールアドレス。メールアドレスは 256 文字未満で、name@domain.tld の形式にする必要があります。また、メールは RFC 822 の addr-spec 本番環境と一致している必要があります。

string

Identity Platform アカウントの有効な ID トークン。承認されると、このリクエストにより、この ID トークンで表されるユーザーにメールアドレスがリンクされ、今後、アカウントでメールリンクによるログインが可能になります。

string

ユーザーがログインしている Identity Platform テナントの ID。設定されていない場合、ユーザーはデフォルトの Identity Platform プロジェクトにログインします。

string

string

認証済みユーザーの Identity Platform ID トークン。

string

ユーザーがログインに使用したメールアドレス。レスポンスには常に存在します。

string

認証されたユーザーの更新トークン。

int64

ID トークンの有効期限が切れるまでの秒数。

string

認証されたユーザーの ID。レスポンスには常に存在します。

bool

認証済みユーザーがこのリクエストによって作成されたかどうか。

string

ユーザーが第 1 要素のチェックに合格したことを証明する不透明な文字列。

MfaEnrollment

有効になっている多要素認証プロバイダの情報。ユーザーが多要素認証を使用してログインを完了する必要がある場合に表示します。

string

必須。ユーザーの Game Center プレーヤー ID。Apple によって非推奨になりました。

playerID を gamePlayerID と teamPlayerID とともに渡して、ユーザーの Game Center プレーヤー ID を gamePlayerID に移行します。

string

必須。指定された署名が Apple によって署名されていることを検証するために Apple 公開鍵を取得する URL。

string

必須。Apple によって生成された検証署名データ。

string

必須。指定された署名の生成に使用されるランダムな文字列。

int64

必須。Apple によって署名が作成された日時をエポックからの経過時間（ミリ秒単位）で示します。

string

Identity Platform アカウントの有効な ID トークン。存在する場合、このリクエストにより、Game Center プレーヤー ID がこの ID トークンによって表されるアカウントにリンクされます。

string

ユーザーの Game Center の表示名。

string

ユーザーがログインしている Identity Platform テナントの ID。

string

ユーザーの Game Center チームのプレーヤー ID。デベロッパー アカウントを使用して配信するすべてのゲームのプレーヤーの一意の識別子。https://developer.apple.com/documentation/gamekit/gkplayer/3174857-teamplayerid

string

ユーザーの Game Center ゲーム プレーヤー ID。ゲームのプレーヤーの一意の識別子。https://developer.apple.com/documentation/gamekit/gkplayer/3113960-gameplayerid

string

認証されたユーザーの ID。レスポンスには常に存在します。

string

ユーザーの Game Center プレーヤー ID。

playerID を gamePlayerID と teamPlayerID とともに渡して、ユーザーの Game Center プレーヤー ID を gamePlayerID に移行します。

string

認証済みユーザーの Identity Platform ID トークン。

string

認証されたユーザーの Identity Platform 更新トークン。

int64

ID トークンの有効期限が切れるまでの秒数。

bool

ログイン中のユーザーがこのリクエストによって作成されたかどうか。

string

認証されたユーザーの表示名。

string

ユーザーの Game Center チームのプレーヤー ID。デベロッパー アカウントを使用して配信するすべてのゲームのプレーヤーの一意の識別子。https://developer.apple.com/documentation/gamekit/gkplayer/3174857-teamplayerid

string

ユーザーの Game Center ゲーム プレーヤー ID。ゲームのプレーヤーの一意の識別子。https://developer.apple.com/documentation/gamekit/gkplayer/3113960-gameplayerid

string

必須。IdP がユーザーをリダイレクトする URL。ユーザーが手動で指定した IdP 認証情報でログインする場合は、http://localhost に設定できます。

string

ユーザーが、以前の CreateAuthUri 認可リクエストで取得した認可レスポンスでログインしている場合、これは IdP からの HTTP POST コールバックの本文です（存在する場合）。

それ以外の場合、ユーザーが手動で提供した IdP 認証情報でログインする場合は、認証情報（OAuth 2.0 IdP の ID トークンやアクセス トークンなど）と、認証情報を発行した IdP のプロバイダ ID を含む URL エンコードされたフォームである必要があります。

たとえば、ユーザーが Google ID トークンを使用して Google プロバイダにログインする場合は、id_token=[GOOGLE_ID_TOKEN]&providerId=google.com に設定します。ここで、[GOOGLE_ID_TOKEN] は Google ID トークンに置き換えます。

ユーザーが Facebook 認証トークンを使用して Facebook プロバイダにログインする場合は、id_token=[FACEBOOK_AUTHENTICATION_TOKEN]&providerId=facebook. com&nonce= [NONCE] に設定します。ここで、[FACEBOOK_AUTHENTICATION_TOKEN] は Facebook 認証トークンに置き換えます。トークンの検証にはノンスが必要です。ノンスが指定されていない場合、リクエストは失敗します。

ユーザーが Facebook アクセス トークンを使用して Facebook プロバイダにログインする場合は、access_token=[FACEBOOK_ACCESS_TOKEN]&providerId=facebook. com に設定します。ここで、[FACEBOOK_ACCESS_TOKEN] は Facebook アクセス トークンに置き換えます。

ユーザーが Twitter OAuth 1.0 認証情報を使用して Twitter プロバイダにログインする場合は、access_token=[TWITTER_ACCESS_TOKEN]&oauth_token_secret= [TWITTER_TOKEN_SECRET]&providerId=twitter.com に設定します。ここで、[TWITTER_ACCESS_TOKEN] と [TWITTER_TOKEN_SECRET] は、Twitter OAuth アクセス トークンと Twitter OAuth トークン シークレットに置き換える必要があります。

string

bool

IdP から OAuth 更新トークンを返すかどうか（使用可能な場合）。

string

前の CreateAuthUri 呼び出しから返されたセッション ID。このフィールドは、セッション修正攻撃を防ぐために、そのセッション ID と照合されます。ユーザーが以前の CreateAuthUri 認可リクエストの認可レスポンスでログインする場合に必須です。

int64

string

有効な Identity Platform ID トークン。承認されると、IdP のユーザー アカウントが、この ID トークンによって表されるアカウントにリンクされます。

bool

常に true を指定します。

bool

FEDERATED_USER_ID_ALREADY_LINKED と EMAIL_EXISTS のエラーで IdP から OAuth 認証情報を返すかどうか。

bool

string

ユーザーがログインしている Identity Platform テナントの ID。設定されていない場合、ユーザーはデフォルトの Identity Platform プロジェクトにログインします。

string

以前の SignInWithIdp レスポンスからの不透明な文字列。設定すると、前の SignInWithIdp オペレーションのログイン オペレーションを繰り返すことができます。これは、ユーザーが以前の連携ログイン試行の一環としてアカウント情報を確認する必要がある場合や、アカウントのリンクを行う必要がある場合に表示されます。

string

IdP でのユーザーのアカウント ID。レスポンスには常に存在します。

string

ユーザーがログインしている IdP のプロバイダ ID。レスポンスには常に存在します。

string

IdP のユーザー アカウントのメールアドレス。

bool

ユーザー アカウントのメールアドレスが確認済みかどうか。

string

IdP のユーザー アカウントの名。

string

IdP のユーザー アカウントの氏名。

string

IdP のユーザー アカウントの姓。

string

IdP のユーザー アカウントのニックネーム。

string

IdP のユーザー アカウントの言語設定。

string

IdP のユーザー アカウントのタイムゾーン。

string

IdP のユーザーのプロフィール写真の URL。

string

IdP のユーザー アカウントの生年月日。

string

string

ユーザーの Identity Platform アカウントのメインの（トップレベルの）メールアドレス（IdP のメールアドレスと異なる場合）。[1 つのメールアドレスにつき 1 つのアカウント] の設定が有効になっている場合にのみ存在します。

string

認証された Identity Platform ユーザーの ID。レスポンスには常に存在します。

bool

同じメールアドレスで、同じ IdP の別のアカウントにリンクされている既存の Identity Platform ユーザー アカウントがあるかどうか。[1 つのメールアドレスにつき 1 つのアカウント] の設定が有効で、IdP のメールアドレスが確認されている場合にのみ存在します。

string

IdP でのユーザーのアカウントの表示名。

string

認証済みユーザーの Identity Platform ID トークン。

string

CreateAuthUri で設定される不透明な文字列。認証リクエストと IdP からのコールバック間のコンテキスト情報を維持するために使用されます。

string

need_confirmation エラーを解決するためにユーザーがログインできるプロバイダ ID のリスト。need_confirmation が true に設定されている場合にのみ存在します。

bool

IdP でログインしている現在のアカウントと同じメールアドレスを持つ既存の Identity Platform ユーザー アカウントが存在するかどうか、およびアカウントのメールアドレスが IdP で確認されていないかどうか。ユーザーは、既存の Identity Platform アカウントにログインし、IdP の現在の認証情報をリンクする必要があります。[1 つのメールアドレスにつき 1 つのアカウント] の設定が有効になっている場合にのみ存在します。

string

IdP の OAuth アクセス トークン（使用可能な場合）。

string

IdP の OAuth 2.0 リフレッシュ トークン（return_refresh_token が true に設定されている場合）。

int32

IdP の OAuth アクセス トークンが期限切れになるまでの秒数。

string

OAuth 2.0 認証コード（利用可能な場合）。Google プロバイダでのみ存在します。

bool

string

IdP の OAuth 1.0 トークン シークレット（使用可能な場合）。Twitter プロバイダでのみ存在します。

string

認証されたユーザーの Identity Platform 更新トークン。

int64

Identity Platform ID トークンが期限切れになるまでの秒数。

string

IdP の OpenID Connect ID トークン（使用可能な場合）。

string

Twitter IdP のユーザー アカウントのスクリーン名、または GitHub IdP のユーザー アカウントのログイン名。

string

IdP のユーザー アカウントに対応するすべてのデータを含む、文字列化された JSON レスポンス。

string

return_idp_credential が true に設定され、FEDERATED_USER_ID_ALREADY_LINKED エラーまたは EMAIL_EXISTS エラーが発生した場合に返されるエラー メッセージ。このフィールドの値は FEDERATED_USER_ID_ALREADY_LINKED または EMAIL_EXISTS です。

bool

認証されたユーザーに新しい Identity Platform アカウントが作成されたかどうか。

string

string

ユーザーがログインしている IdP の認証情報として使用できる不透明な文字列。ここで取得した保留中のトークンは、今後の SignInWithIdp リクエストで設定して、同じユーザーを IdP で再度ログインさせることができます。

string

リクエストの tenant_id フィールドの値。

string

ユーザーが第 1 要素認証に正常に合格したことを証明する不透明な文字列。

MfaEnrollment

アカウントで有効になっている多要素認証プロバイダの情報。ユーザーが多要素認証を使用してログインを完了する必要がある場合に表示します。

string

必須。ユーザーがログインに使用するメールアドレス。メールアドレスは 256 文字未満で、name@domain.tld の形式にする必要があります。また、メールは RFC 822 addr-spec 本番環境と一致している必要があります。

string

必須。ユーザーがアカウントへのログインに指定したパスワード。

string

string

string

reCAPTCHA クライアントサイド統合によって提供される reCAPTCHA トークン。reCAPTCHA Enterprise は、リスク評価に使用します。reCAPTCHA Enterprise が有効になっている場合に必須です。

string

int64

string

bool

常に true を指定します。

string

ユーザーがログインしている Identity Platform テナントの ID。設定されていない場合、ユーザーはプロジェクトのデフォルトの Identity Platform インスタンスにログインします。

ClientType

クライアントの種類（web、android、ios）。reCAPTCHA Enterprise が有効になっている場合に必須です。

RecaptchaVersion

captcha_response 内の reCAPTCHA トークンの reCAPTCHA バージョン。

string

string

認証されたユーザーの ID。レスポンスには常に存在します。

string

認証されたユーザーのメールアドレス。レスポンスには常に存在します。

string

アカウントの属性に保存されているユーザーの表示名。

string

認証済みユーザーの Identity Platform ID トークン。

bool

メールアドレスが既存アカウントのものかどうか。常に true です。

string

アカウントの属性に保存されているユーザーのプロフィール写真。

string

OAuth2 アクセス トークン。

int32

アクセス トークンの有効期限（秒単位）。

string

string

認証されたユーザーの Identity Platform 更新トークン。

int64

Identity Platform ID トークンが期限切れになるまでの秒数。

string

ユーザーが第 1 要素認証に正常に合格したことを証明する不透明な文字列。

MfaEnrollment

アカウントで有効になっている多要素認証プロバイダの情報。ユーザーが多要素認証を使用してログインを完了する必要がある場合に表示します。

UserNotification

ユーザーへの警告通知。

string

[sendVerificationCode][v1.accounts.sendVerificationCode] のレスポンスから取得した暗号化されたセッション情報。SMS コードで認証する場合は指定する必要がありますが、一時的な証明書を使用する場合は指定する必要はありません。

string

ログインに使用するユーザーの電話番号。これは、一時的な証明書を使用する場合に必要です。この場合、一時的な証明書を生成するリクエストで認証された電話番号と一致している必要があります。セッション情報が渡された場合、このフィールドは無視されます。

string

ユーザーのスマートフォンに送信された SMS からユーザーが入力した確認コード。

string

以前の [signInWithPhoneNumber][v1.accounts.signInWithPhoneNumber] リクエストで提供された、電話番号確認の証明書。これが渡された場合、呼び出し元は、前のリクエストで確認された電話番号を phone_number フィールドに渡す必要があります。

string

使用しないでください。

string

Identity Platform アカウントの有効な ID トークン。渡された場合、このリクエストは、電話番号が使用されていない場合は、この ID トークンによって表されるユーザーに電話番号をリンクします。電話番号がすでにユーザーにリンクされている場合は、ユーザーの再認証を行います。

VerifyOp

string

ユーザーがログインしている Identity Platform テナントの ID。設定されていない場合、ユーザーはデフォルトの Identity Platform プロジェクトにログインします。

string

認証済みユーザーの Identity Platform ID トークン。

string

認証されたユーザーの更新トークン。

int64

ID トークンの有効期限が切れるまでの秒数。

string

認証されたユーザーの ID。認証が成功した場合に存在します。スマートフォンの確認は完了したが、アカウントの操作が完了しなかった場合は、代わりに一時的な証明書が返されます。

bool

認証済みユーザーがこのリクエストによって作成されたかどうか。

string

電話番号の確認の証明書。電話認証は成功したが、ユーザー操作が失敗した場合に提供されます。これは、リクエストで ID トークンを使用して電話番号をユーザーにリンクしようとした場合や、ID トークンを使用して再認証しようとした場合に、電話番号が別のユーザーにリンクされている場合に発生します。

string

使用しないでください。

int64

使用しないでください。

string

認証されたユーザーの電話番号。レスポンスには常に存在します。

int64

一時的な証明書が期限切れになるまでの秒数。

string

作成したユーザーに割り当てるメールアドレス。メールの長さは 256 文字未満で、name@domain.tld の形式にする必要があります。また、メールは RFC 822 の addr-spec 本番環境と一致している必要があります。指定しない場合、匿名ユーザーが作成されます。

string

作成したユーザーに割り当てるパスワード。パスワードは 6 文字以上にする必要があります。設定する場合は、email フィールドも設定する必要があります。

string

作成するユーザーの表示名。

string

string

reCAPTCHA クライアントサイド統合によって提供される reCAPTCHA トークン。reCAPTCHA Enterprise は、このトークンを評価に使用します。reCAPTCHA Enterprise が有効になっている場合は必須です。

string

string

Identity Platform ユーザーの有効な ID トークン。設定すると、このリクエストで認証認証情報がこの ID トークンによって表されるユーザーにリンクされます。管理者以外のリクエストの場合は、email フィールドと password フィールドの両方を設定する必要があります。管理リクエストの場合、local_id は設定しないでください。

bool

ユーザーのメールアドレスが確認済みかどうか。このフィールドを指定する場合は、適切な権限を持つ Google OAuth 2.0 認証情報が必要です。

string

作成するユーザーのプロフィール写真の URL。

bool

ユーザーを作成時に無効にするかどうか。無効になったアカウントには、適切な権限を持つ Google OAuth2 認証情報を含むリクエストを除き、アクセスできません。

string

作成するユーザーの ID。ID は、ユーザーが作成されるプロジェクト内で一意である必要があります。このフィールドを指定する場合は、適切な権限を持つ Google OAuth 2.0 認証情報が必要です。

string

作成するユーザーの電話番号。このフィールドを指定する場合は、適切な権限を持つ Google OAuth 2.0 認証情報が必要です。

string

ユーザーを作成する Identity Platform テナントの ID。設定しない場合、ユーザーはデフォルトの Identity Platform プロジェクトの下に作成されます。

string

ユーザーが属する必要があるプロジェクトのプロジェクト ID。このフィールドを指定するには、適切な権限を持つ Google OAuth 2.0 認証情報が必要です。これが設定されていない場合、ターゲット プロジェクトは Bearer アクセス トークンに関連付けられたスコープから推測されます。

MfaFactor

ユーザーが作成する多要素認証プロバイダ。

ClientType

クライアントの種類: ウェブ、Android、iOS。reCAPTCHA Enterprise 保護を有効にする場合に必要です。

RecaptchaVersion

captcha_response 内の reCAPTCHA トークンの reCAPTCHA バージョン。

string

この mfa オプションの表示名（例: 「社用携帯電話」）。

string

多要素認証用の OTP を受信する電話番号。

string

string

作成されたユーザーの Identity Platform ID トークン。このフィールドは、管理者以外のリクエストでのみ設定されます。

string

作成したユーザーの表示名。

string

作成したユーザーのメールアドレス。

string

作成されたユーザーの Identity Platform 更新トークン。このフィールドは、管理者以外のリクエストでのみ設定されます。

int64

ID トークンの有効期限が切れるまでの秒数。

string

作成されたユーザーの ID。レスポンスには常に存在します。

string

必須。アカウント パスワードのハッシュに使用されるハッシュ関数。次のいずれかである必要があります。* HMAC_SHA256 * HMAC_SHA1 * HMAC_MD5 * SCRYPT * PBKDF_SHA1 * MD5 * HMAC_SHA512 * SHA1 * BCRYPT * PBKDF2_SHA256 * SHA256 * SHA512 * STANDARD_SCRYPT * ARGON2

bytes

パスワードのハッシュに使用される署名者鍵。次のハッシュ関数では必須です。* SCRYPT、* HMAC_MD5、* HMAC_SHA1、* HMAC_SHA256、* HMAC_SHA512

bytes

ソルトと平文のパスワードの間に挿入する 1 つ以上のバイト。セキュリティを強化するには、印刷できない文字を 1 つ指定します。

int32

ハッシュ計算に使用されるラウンドの数。次のハッシュ関数でのみ必要です。* MD5 * SHA1 * SHA256 * SHA512 * PBKDF_SHA1 * PBKDF2_SHA256 * SCRYPT

int32

ハッシュ計算のメモリコスト。ハッシュ関数が SCRYPT の場合にのみ必要です。

UserInfo

アップロードするアカウントのリスト。local_id はユーザーごとに必須です。それ以外は任意です。

int64

bool

true の場合、アカウントがアップロードされる前に、サービスは次のチェックを行います。* 重複するメールアドレス * 重複する連携 ID * 連携 ID プロバイダの検証 アップロードするアカウントのリスト内に重複が存在する場合、リスト全体がアップロードされません。メールまたは連携 ID が、プロジェクトまたはテナント内にすでに存在するユーザーの重複である場合、そのアカウントはアップロードされませんが、他のアカウントには影響しません。false の場合、これらのチェックはスキップされます。

string

アカウントが属する Identity Platform プロジェクトのプロジェクト ID。

認可には、指定されたリソース targetProjectId に対する次の IAM の権限が必要です。

• firebaseauth.users.create

bool

Identity Platform の既存のアカウントを、リクエスト内の一致する local_id で上書きするかどうか。true の場合、既存のアカウントが上書きされます。false の場合、エラーが返されます。

int32

STANDARD_SCRYPT ハッシュ関数で使用される CPU メモリ費用パラメータ。このパラメータは、block_size と cpu_mem_cost とともに、パスワードのハッシュ化に必要なリソースを調整するのに役立ちます。プロセッサの速度とメモリ技術の進歩に応じて調整する必要があります。

int32

STANDARD_SCRYPT ハッシュ関数で使用される並列化コスト パラメータ。このパラメータは、block_size と cpu_mem_cost とともに、パスワードのハッシュ化に必要なリソースを調整するのに役立ちます。プロセッサの速度とメモリ技術の進歩に合わせて調整する必要があります。

int32

STANDARD_SCRYPT ハッシュ関数で使用されるブロックサイズ パラメータ。このパラメータは、並列化と cpu_mem_cost とともに、パスワードのハッシュ化に必要なリソースを調整するのに役立ちます。プロセッサの速度とメモリ技術の進歩に応じて調整する必要があります。

int32

STANDARD_SCRYPT ハッシュ関数に必要な鍵の長さ。1 以上の値にする必要があります。

PasswordHashOrder

string

アカウントが属する Identity Platform テナントの ID。

Argon2Parameters

Argon2 ハッシュ アルゴリズムのパラメータ。

string

ErrorInfo

アップロードできないアカウントに関する詳細なエラー情報。

string

変更不可。アカウントの一意の ID。

string

アカウントのメールアドレス。メールの長さは 256 文字未満で、name@domain.tld の形式にする必要があります。また、メールは RFC 822 の addr-spec と一致している必要があります。

string

アカウントの表示名。このアカウント属性は Identity Platform では使用されません。情報提供のみを目的としています。

string

出力専用。アカウントの言語設定。このアカウント属性は Identity Platform では使用されません。情報提供のみを目的としています。

string

アカウントのプロフィール写真の URL。このアカウント属性は Identity Platform では使用されません。情報提供のみを目的としています。

string

出力専用。アカウントのタイムゾーン設定。このアカウント属性は Identity Platform では使用されません。情報提供のみを目的としています。

string

出力専用。アカウントに設定されている生年月日。このアカウント属性は Identity Platform では使用されません。情報提供のみを目的としています。

bytes

アカウントのハッシュ化されたパスワード。適切な権限を持つ Google OAuth2 認証情報を含むリクエストでのみアクセスできます。

bytes

アカウントのパスワード ソルト。適切な権限を持つ Google OAuth2 認証情報を含むリクエストでのみアクセスできます。

int32

アカウントのパスワードのバージョン。適切な権限を持つ Google OAuth2 認証情報を含むリクエストでのみアクセスできます。

bool

アカウントのメールアドレスが確認済みかどうか。

double

アカウントのパスワードが最後に更新されたタイムスタンプ（エポック 1970-01-01T00:00:00Z からの経過ミリ秒数）。

ProviderUserInfo

さまざまな ID プロバイダから提供されたユーザーに関する情報。

int64

ID トークンが有効と見なされる最も古いタイムスタンプ（エポックからの秒単位）。この時間より前に発行された ID トークンはすべて無効と見なされます。

bool

アカウントが無効かどうか。無効なアカウントには、適切な権限を持つ Google OAuth2 認証情報を含むリクエストを除き、アクセスできません。

int64

このアカウントが最後にログインされた日時（エポックからのミリ秒単位）。

int64

アカウントが作成された日時（エポックからのミリ秒単位）。

string

出力専用。このアカウントの Twitter のスクリーン名または GitHub のログイン名。

bool

出力専用。このアカウントが SignInWithCustomToken を使用して認証されているかどうか。

string

入力のみのアカウントのパスワードの更新に使用されるプレーンテキスト パスワード。このフィールドは、リクエストの入力としてのみ使用されます。Identity Platform は、パスワードの管理時に暗号的に安全なハッシュ化を使用します。ユーザーのパスワードを平文で保存または送信することはありません。

string

アカウントの電話番号。

string

アカウント用に生成された ID トークンに追加するカスタム クレーム。最大 1,000 文字で、有効な JSON 形式である必要があります。

bool

出力専用。アカウントがメールリンクで認証できるかどうか。

string

このアカウントが属するテナントの ID。このアカウントがテナントに属している場合にのみ設定します。

MfaEnrollment

このアカウントで有効になっている多要素認証プロバイダに関する情報。

string

このアカウントに最初に関連付けられたメールアドレス。アカウントの初期メールアドレスは設定後に変更できません。このメールアドレスは、GetOobCode の RECOVER_EMAIL フローを通じてアカウントへのアクセス権を失った場合に、そのアカウントへのアクセス権を復元するために使用されます。RFC 822 の addr-spec と一致している必要があります。

Timestamp

このアカウントの ID トークンが最後に発行されたときのタイムスタンプ。

NotificationCode

警告通知の列挙型。ローカライズに使用できます。

string

警告通知の文字列。フォールバックとして使用できます。

string

iOS クライアントが APN（Apple Push Notification Service）に登録した後に取得するデバイス トークン。

bool

アプリトークンが iOS サンドボックス内にあるかどうか。false の場合、アプリトークンは本番環境にあります。

string

アプリトークンの検証が成功したことの通知。

int64

プッシュ通知の配信を待機するクライアントに推奨される時間（秒単位）。