このページは Cloud Translation API によって翻訳されました。

Method: accounts.signInWithEmailLink

HTTP リクエスト
リクエストの本文
- JSON 表現
レスポンスの本文
- JSON 表現
認可スコープ
試してみる

メールのリンクに記載された帯域外のコードを使用してユーザーをログインまたは登録します。指定されたメールアドレスのユーザーが存在しない場合、ユーザーレコードが作成されます。ログインに成功すると、認証されたユーザーに Identity Platform ID と更新トークンが発行されます。

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

HTTP リクエスト

POST https://identitytoolkit.googleapis.com/v1/accounts:signInWithEmailLink

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

リクエストの本文

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

JSON 表現
{ "oobCode": string, "email": string, "idToken": string, "tenantId": string }

フィールド
`oobCode`	`string` 必須。メールのリンクに記載された帯域外のコード。
`email`	`string` 必須。ログインリンクが送信されたメールアドレス。メールアドレスは 256 文字未満で、`name@domain.tld` の形式にする必要があります。また、メールは RFC 822 の addr-spec 本番環境と一致している必要があります。
`idToken`	`string` Identity Platform アカウントの有効な ID トークン。承認されると、このリクエストにより、この ID トークンで表されるユーザーにメールアドレスがリンクされ、今後、アカウントでメールリンクによるログインが可能になります。
`tenantId`	`string` ユーザーがログインしている Identity Platform テナントの ID。設定されていない場合、ユーザーはデフォルトの Identity Platform プロジェクトにログインします。

レスポンスの本文

accounts.signInWithEmailLink のレスポンスメッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現

JSON 表現
{ "kind": string, "idToken": string, "email": string, "refreshToken": string, "expiresIn": string, "localId": string, "isNewUser": boolean, "mfaPendingCredential": string, "mfaInfo": [ { object (`MfaEnrollment`) } ] }

{
  "kind": string,
  "idToken": string,
  "email": string,
  "refreshToken": string,
  "expiresIn": string,
  "localId": string,
  "isNewUser": boolean,
  "mfaPendingCredential": string,
  "mfaInfo": [
    {
      object (MfaEnrollment)
    }
  ]
}

フィールド
`kind (deprecated)`	`string` この項目は非推奨です。
`idToken`	`string` 認証済みユーザーの Identity Platform ID トークン。
`email`	`string` ユーザーがログインに使用したメールアドレス。レスポンスには常に存在します。
`refreshToken`	`string` 認証されたユーザーの更新トークン。
`expiresIn`	`string (int64 format)` ID トークンの有効期限が切れるまでの秒数。
`localId`	`string` 認証されたユーザーの ID。レスポンスには常に存在します。
`isNewUser`	`boolean` 認証済みユーザーがこのリクエストによって作成されたかどうか。
`mfaPendingCredential`	`string` ユーザーが第 1 要素のチェックに合格したことを証明する不透明な文字列。
`mfaInfo[]`	`object (MfaEnrollment)` 有効になっている多要素認証プロバイダの情報。ユーザーが多要素認証を使用してログインを完了する必要がある場合に表示します。

認可スコープ

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

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

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