Stay organized with collections
Save and categorize content based on your preferences.
FirebaseAdmin.Auth.FirebaseToken
Represents a valid, decoded Firebase ID token.
Summary
It can be used to get the Uid and other claims available in the token.
Properties
|
Audience
|
string
Gets the audience claim that identifies the audience that the JWT is intended for.
|
Claims
|
IReadOnlyDictionary< string, object >
Gets all other claims present in the JWT as a readonly dictionary.
|
ExpirationTimeSeconds
|
long
Gets the expiration time claim that identifies the expiration time (in seconds) on or after which the token MUST NOT be accepted for processing.
|
IssuedAtTimeSeconds
|
long
Gets the issued at claim that identifies the time (in seconds) at which the JWT was issued.
|
Issuer
|
string
Gets the issuer claim that identifies the principal that issued the JWT.
|
Subject
|
string
Gets the subject claim identifying the principal that is the subject of the JWT.
|
TenantId
|
string
Gets the ID of the tenant the user belongs to, if available.
|
Uid
|
string
Gets the User ID of the user to which this ID token belongs.
|
Properties
Audience
string Audience
Gets the audience claim that identifies the audience that the JWT is intended for.
Claims
IReadOnlyDictionary< string, object > Claims
Gets all other claims present in the JWT as a readonly dictionary.
This can be used to access custom claims of the token.
ExpirationTimeSeconds
long ExpirationTimeSeconds
Gets the expiration time claim that identifies the expiration time (in seconds) on or after which the token MUST NOT be accepted for processing.
IssuedAtTimeSeconds
long IssuedAtTimeSeconds
Gets the issued at claim that identifies the time (in seconds) at which the JWT was issued.
Issuer
string Issuer
Gets the issuer claim that identifies the principal that issued the JWT.
Subject
string Subject
Gets the subject claim identifying the principal that is the subject of the JWT.
TenantId
string TenantId
Gets the ID of the tenant the user belongs to, if available.
Returns null if the ID token is not scoped to a tenant.
Uid
string Uid
Gets the User ID of the user to which this ID token belongs.
This is same as Subject.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-03-24 UTC.
[null,null,["Last updated 2022-03-24 UTC."],[],[],null,["# FirebaseAdmin.Auth.FirebaseToken Class Reference\n\nFirebaseAdmin.Auth.FirebaseToken\n================================\n\nRepresents a valid, decoded Firebase ID token.\n\nSummary\n-------\n\nIt can be used to get the `Uid` and other claims available in the token.\n\n| ### Properties ||\n|---------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Audience](#class_firebase_admin_1_1_auth_1_1_firebase_token_1ac5d569ee58c9d8b39c31f6fa04359088) | `string` Gets the audience claim that identifies the audience that the JWT is intended for. |\n| [Claims](#class_firebase_admin_1_1_auth_1_1_firebase_token_1adee2c4bbda3ee99ae55ccb18be367f3a) | `IReadOnlyDictionary\u003c string, object \u003e` Gets all other claims present in the JWT as a readonly dictionary. |\n| [ExpirationTimeSeconds](#class_firebase_admin_1_1_auth_1_1_firebase_token_1aa61c90772ca9ea3206fa0e92d5c08fc1) | `long` Gets the expiration time claim that identifies the expiration time (in seconds) on or after which the token MUST NOT be accepted for processing. |\n| [IssuedAtTimeSeconds](#class_firebase_admin_1_1_auth_1_1_firebase_token_1a9200a5395586efc54d300155b5f4568e) | `long` Gets the issued at claim that identifies the time (in seconds) at which the JWT was issued. |\n| [Issuer](#class_firebase_admin_1_1_auth_1_1_firebase_token_1adf4ea099ac54cebbcddf18f72483b491) | `string` Gets the issuer claim that identifies the principal that issued the JWT. |\n| [Subject](#class_firebase_admin_1_1_auth_1_1_firebase_token_1aa3c512852864eee21e62276176a5350f) | `string` Gets the subject claim identifying the principal that is the subject of the JWT. |\n| [TenantId](#class_firebase_admin_1_1_auth_1_1_firebase_token_1a3974cc2a8996d9ec9ea26b86e672c3f5) | `string` Gets the ID of the tenant the user belongs to, if available. |\n| [Uid](#class_firebase_admin_1_1_auth_1_1_firebase_token_1ac22a3a61f7c0e5f2e07ea912fc6c169a) | `string` Gets the User ID of the user to which this ID token belongs. |\n\nProperties\n----------\n\n### Audience\n\n```text\nstring Audience\n``` \nGets the audience claim that identifies the audience that the JWT is intended for. \n\n### Claims\n\n```text\nIReadOnlyDictionary\u003c string, object \u003e Claims\n``` \nGets all other claims present in the JWT as a readonly dictionary.\n\nThis can be used to access custom claims of the token. \n\n### ExpirationTimeSeconds\n\n```text\nlong ExpirationTimeSeconds\n``` \nGets the expiration time claim that identifies the expiration time (in seconds) on or after which the token MUST NOT be accepted for processing. \n\n### IssuedAtTimeSeconds\n\n```text\nlong IssuedAtTimeSeconds\n``` \nGets the issued at claim that identifies the time (in seconds) at which the JWT was issued. \n\n### Issuer\n\n```text\nstring Issuer\n``` \nGets the issuer claim that identifies the principal that issued the JWT. \n\n### Subject\n\n```text\nstring Subject\n``` \nGets the subject claim identifying the principal that is the subject of the JWT. \n\n### TenantId\n\n```text\nstring TenantId\n``` \nGets the ID of the tenant the user belongs to, if available.\n\nReturns null if the ID token is not scoped to a tenant. \n\n### Uid\n\n```text\nstring Uid\n``` \nGets the User ID of the user to which this ID token belongs.\n\nThis is same as [Subject](/docs/reference/admin/dotnet/class/firebase-admin/auth/firebase-token#class_firebase_admin_1_1_auth_1_1_firebase_token_1aa3c512852864eee21e62276176a5350f)."]]
