Method: accounts.signInWithPassword

メールアドレスとパスワードを使用してユーザーのログインを行います。ログインに成功すると、認証されたユーザーに新しい Identity Platform ID トークンと更新トークンが発行されます。

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

HTTP リクエスト

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

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

リクエストの本文

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

JSON 表現 
{
  "email": string,
  "password": string,
  "pendingIdToken": string,
  "captchaChallenge": string,
  "captchaResponse": string,
  "instanceId": string,
  "delegatedProjectNumber": string,
  "idToken": string,
  "returnSecureToken": boolean,
  "tenantId": string,
  "clientType": enum (ClientType),
  "recaptchaVersion": enum (RecaptchaVersion)
}
フィールド
email

string

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

string

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

string
captchaChallenge
(deprecated)

string
captchaResponse

string

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

string
delegatedProjectNumber
(deprecated)

string (int64 format)
idToken
(deprecated)

string
returnSecureToken

boolean

常に true を指定します。
tenantId

string

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

enum (ClientType)

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

enum (RecaptchaVersion)

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

レスポンスの本文

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

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

JSON 表現 
{
  "kind": string,
  "localId": string,
  "email": string,
  "displayName": string,
  "idToken": string,
  "registered": boolean,
  "profilePicture": string,
  "oauthAccessToken": string,
  "oauthExpireIn": integer,
  "oauthAuthorizationCode": string,
  "refreshToken": string,
  "expiresIn": string,
  "mfaPendingCredential": string,
  "mfaInfo": [
    {
      object (MfaEnrollment)
    }
  ],
  "userNotifications": [
    {
      object (UserNotification)
    }
  ]
}
フィールド
kind
(deprecated)

string
localId

string

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

string

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

string

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

string

認証済みユーザーの Identity Platform ID トークン。
registered
(deprecated)

boolean

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

string

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

string

OAuth2 アクセス トークン。
oauthExpireIn
(deprecated)

integer

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

string
refreshToken

string

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

string (int64 format)

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

string

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

object (MfaEnrollment)

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

object (UserNotification)

ユーザーへの警告通知。

認可スコープ

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

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

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

UserNotification

ユーザーへの警告通知。

JSON 表現 
{
  "notificationCode": enum (NotificationCode),
  "notificationMessage": string
}
フィールド
notificationCode

enum (NotificationCode)

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

string

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

NotificationCode

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

列挙型
NOTIFICATION_CODE_UNSPECIFIED 通知が指定されていません。
MISSING_LOWERCASE_CHARACTER パスワードに小文字が含まれていません。
MISSING_UPPERCASE_CHARACTER パスワードに大文字が含まれていません。
MISSING_NUMERIC_CHARACTER パスワードに数字が含まれていません。
MISSING_NON_ALPHANUMERIC_CHARACTER パスワードに英数字以外の文字が含まれていません。
MINIMUM_PASSWORD_LENGTH パスワードが最小要件の長さ未満です。
MAXIMUM_PASSWORD_LENGTH パスワードが必要な最大文字数を超えている。