Method: projects.tenants.accounts.update

特定のフィールドを設定するか、アクション コードを適用して、指定したユーザーのアカウント関連情報を更新します。管理者とエンドユーザーからのリクエストがサポートされています。

HTTP リクエスト

POST https://identitytoolkit.googleapis.com/v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:update

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
targetProjectId

string

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

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

  • firebaseauth.users.update
tenantId

string

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

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "idToken": string,
  "localId": string,
  "displayName": string,
  "email": string,
  "password": string,
  "provider": [
    string
  ],
  "oobCode": string,
  "emailVerified": boolean,
  "upgradeToFederatedLogin": boolean,
  "captchaChallenge": string,
  "captchaResponse": string,
  "validSince": string,
  "disableUser": boolean,
  "instanceId": string,
  "delegatedProjectNumber": string,
  "photoUrl": string,
  "deleteAttribute": [
    enum (UserAttributeName)
  ],
  "returnSecureToken": boolean,
  "deleteProvider": [
    string
  ],
  "lastLoginAt": string,
  "createdAt": string,
  "phoneNumber": string,
  "customAttributes": string,
  "mfa": {
    object (MfaInfo)
  },
  "linkProviderUserInfo": {
    object (ProviderUserInfo)
  }
}
フィールド
idToken

string

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

string

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

string

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

string

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

string

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

string

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

string

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

boolean

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

boolean

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

string
captchaResponse

string

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

string (int64 format)

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

boolean

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

string
delegatedProjectNumber
(deprecated)

string (int64 format)
photoUrl

string

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

enum (UserAttributeName)
returnSecureToken

boolean

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

string

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

string (int64 format)

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

string (int64 format)

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

string

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

string

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

object (MfaInfo)

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

レスポンスの本文

成功した場合、レスポンスの本文には SetAccountInfoResponse のインスタンスが含まれます。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。