デコードされた Firebase ID トークンを表すインターフェース。BaseAuth.verifyIdToken() メソッドから返されます。
Firebase ID トークンは、OpenID Connect 仕様に準拠した JSON ウェブトークン(JWT)です。以下の特定のプロパティについて詳しくは、[OpenID Connect 仕様の ID トークン セクション](http://openid.net/specs/openid-connect-core-1_0.html#IDToken)をご覧ください。
署名:
export interface DecodedIdToken
プロパティ
プロパティ | 型 | 説明 |
---|---|---|
音声 | 文字列 | このトークンの対象オーディエンス。この値は、Firebase プロジェクトの一意の識別子である Firebase プロジェクト ID に等しい文字列です。Firebase プロジェクトの ID は、[プロジェクトの設定](https://console.firebase.google.com/project/_/settings/general/android:com.random.android) で確認できます。 |
auth_time | 数値 | エンドユーザー認証が発生した時刻(Unix エポックからの経過秒数)。この値は、この ID トークンが作成された時点ではなく、ユーザーがこのセッションに最初にログインしたときに設定されます。Firebase SDK は、1 回のセッションで 1 時間ごとにユーザーの ID トークンを更新します。ID トークンごとに [iat ](#iat) 値は異なりますが、auth_time 値は同じです。 |
email_verified(メールアドレスが確認済み) | ブール値 | ユーザーがメールを持っている場合、ID トークンが属するユーザーのメールアドレスが検証されるかどうか。 |
文字列 | ID トークンが属するユーザーのメールアドレス(利用可能な場合)。 | |
式 | 数値 | ID トークンの有効期限(Unix エポックからの経過秒数)。つまり、この ID トークンの有効期限が切れ、有効とみなされなくなる時間です。Firebase SDK は 1 時間ごとに ID トークンを透過的に更新し、最大 1 時間の有効期限で新しい ID トークンを発行します。 |
Firebase | { identity: { [キー: 文字列]: 任意;}sign_in_provider: string;sign_in_second_factor?: string;second_factor_identifier?: 文字列;tenant?: string;[キー: 文字列]: 任意;} | 使用されたログイン プロバイダやプロバイダ固有の ID の詳細など、ログイン イベントに関する情報。このデータは Firebase Authentication サービスによって提供され、ID トークン内の予約済みクレームです。 |
iat | 数値 | ID トークンの発行時刻(Unix エポックからの経過秒数)。つまり、この ID トークンが発行され、有効とみなされる開始時刻になります。Firebase SDK は 1 時間ごとに ID トークンを透過的に更新し、発行日時の新しい ID トークンを発行します。ID トークンに対応するユーザー セッションが最初に発生した時刻を取得するには、[auth_time ](#auth_time) プロパティをご覧ください。 |
ミス | 文字列 | レスポンスの発行者の発行者 ID。この値は、https://securetoken.google.com/<PROJECT_ID> 形式の URL です。ここで、<PROJECT_ID> は [aud ](#aud) プロパティで指定されたのと同じプロジェクト ID です。 |
電話番号 | 文字列 | ID トークンが属するユーザーの電話番号(利用可能な場合)。 |
画像 | 文字列 | ID トークンが属するユーザーの写真の URL(利用可能な場合)。 |
サブ | 文字列 | ID トークンが属するユーザーに対応する uid 。便宜上、この値は [uid ](#uid) プロパティにコピーされます。 |
UID | 文字列 | ID トークンが属するユーザーに対応する uid 。この値は、実際には JWT トークン クレーム自体には存在しません。これは便宜上追加され、[sub ](#sub) プロパティの値として設定されます。 |
DecodedIdToken.aud
このトークンの対象となるオーディエンス。
この値は、Firebase プロジェクトの一意の識別子である Firebase プロジェクト ID に等しい文字列です。これは [プロジェクトの設定](https://console.firebase.google.com/project/_/settings/general/android:com.random.android) で確認できます。
署名:
aud: string;
DecodedIdToken.auth_time
エンドユーザー認証が行われた時刻(Unix エポックからの経過秒数)。
この値は、この ID トークンが作成されたときではなく、ユーザーがこのセッションに最初にログインしたときに設定されます。Firebase SDK は、1 回のセッションで 1 時間ごとにユーザーの ID トークンを更新します。ID トークンごとに [iat
](#iat) 値は異なりますが、auth_time
値は同じです。
署名:
auth_time: number;
DecodedIdToken.email_verified
ユーザーがメールを持っている場合、ID トークンが属するユーザーのメールアドレスが検証されるかどうか。
署名:
email_verified?: boolean;
DecodedIdToken.email
ID トークンが属するユーザーのメールアドレス(利用可能な場合)。
署名:
email?: string;
DecodedIdToken.exp
ID トークンの有効期限(Unix エポックからの経過秒数)。つまり、この ID トークンの有効期限が切れ、有効と見なされなくなる時刻です。
Firebase SDK は 1 時間ごとに透過的に ID トークンを更新し、最大 1 時間の有効期限で新しい ID トークンを発行します。
署名:
exp: number;
DecodedIdToken.firebase
使用されたログイン プロバイダやプロバイダ固有の ID の詳細など、ログイン イベントに関する情報。
このデータは Firebase Authentication サービスによって提供され、ID トークン内の予約済みクレームです。
署名:
firebase: {
identities: {
[key: string]: any;
};
sign_in_provider: string;
sign_in_second_factor?: string;
second_factor_identifier?: string;
tenant?: string;
[key: string]: any;
};
DecodedIdToken.iat
ID トークンの発行時刻(Unix エポックからの経過秒数)。つまり、この ID トークンが発行され、有効とみなされる開始時刻になります。
Firebase SDK は 1 時間ごとに透過的に ID トークンを更新し、発行時に新しい ID トークンを発行します。ID トークンに対応するユーザー セッションが最初に発生した時刻を取得するには、[auth_time
](#auth_time) プロパティをご覧ください。
署名:
iat: number;
DecodedIdToken.iss
レスポンスの発行者の発行者 ID。
この値は、https://securetoken.google.com/<PROJECT_ID>
形式の URL です。ここで、<PROJECT_ID>
は [aud
](#aud) プロパティで指定されたプロジェクト ID と同じです。
署名:
iss: string;
DecodedIdToken.phone_number
ID トークンが属するユーザーの電話番号(利用可能な場合)。
署名:
phone_number?: string;
DecodedIdToken.picture
ID トークンが属するユーザーの写真の URL(利用可能な場合)。
署名:
picture?: string;
DecodedIdToken.sub
ID トークンが属するユーザーに対応する uid
。
便宜上、この値は [uid
](#uid) プロパティにコピーされます。
署名:
sub: string;
DecodedIdToken.uid
ID トークンが属するユーザーに対応する uid
。
この値は、実際には JWT トークン クレーム自体には存在しません。これは便宜上追加され、[sub
](#sub) プロパティの値として設定されます。
署名:
uid: string;