Method: projects.accounts

新しいメールアドレスとパスワードのユーザーまたは匿名ユーザーを登録するか、匿名ユーザーをメールアドレスとパスワードにアップグレードします。適切な権限を持つ Google OAuth 2.0 認証情報を含む管理者リクエストの場合、新しい匿名ユーザー（メールアドレスとパスワード、または電話番号）が作成されます。

Google Cloud プロジェクトを識別するには、リクエストに API キーが必要です。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
targetProjectId

string

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

リクエストの本文

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

JSON 表現 
{
  "email": string,
  "password": string,
  "displayName": string,
  "captchaChallenge": string,
  "captchaResponse": string,
  "instanceId": string,
  "idToken": string,
  "emailVerified": boolean,
  "photoUrl": string,
  "disabled": boolean,
  "localId": string,
  "phoneNumber": string,
  "tenantId": string,
  "mfaInfo": [
    {
      object (MfaFactor)
    }
  ],
  "clientType": enum (ClientType),
  "recaptchaVersion": enum (RecaptchaVersion)
}
フィールド
email

string

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

string

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

string

作成するユーザーの表示名。
captchaChallenge
(deprecated)

string
captchaResponse

string

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

string
idToken

string

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

boolean

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

string

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

boolean

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

string

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

string

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

string

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

object (MfaFactor)

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

enum (ClientType)

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

enum (RecaptchaVersion)

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

レスポンスの本文

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

認可スコープ

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

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

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