Stay organized with collections
Save and categorize content based on your preferences.
FirebaseAdmin.Auth.UserRecord
Contains metadata associated with a Firebase user account.
Summary
Instances of this class are immutable and thread safe.
Inheritance
Inherits from:
FirebaseAdmin.Auth.IUserInfoDirect Known Subclasses:
FirebaseAdmin.Auth.ExportedUserRecord
Properties
|
CustomClaims
|
IReadOnlyDictionary< string, object >
Gets the custom claims set on this user, as a non-null dictionary.
|
Disabled
|
bool
Gets a value indicating whether the user account is disabled or not.
|
DisplayName
|
string
Gets the user's display name, if available.
|
Email
|
string
Gets the user's email address, if available.
|
EmailVerified
|
bool
Gets a value indicating whether the user's email address is verified or not.
|
PhoneNumber
|
string
Gets the user's phone number, if available.
|
PhotoUrl
|
string
Gets the user's photo URL, if available.
|
ProviderData
|
Gets a non-null array of provider data for this user.
|
TenantId
|
string
Gets the user's tenant ID, if available.
|
TokensValidAfterTimestamp
|
DateTime
Gets a timestamp that indicates the earliest point in time at which a valid ID token could have been issued to this user.
|
Uid
|
string
Gets the user ID of this user.
|
UserMetaData
|
Gets additional user metadata.
|
Public attributes
|
ProviderId => UserRecord.DefaultProviderId
|
string
Gets the ID of the identity provider.
|
Properties
CustomClaims
IReadOnlyDictionary< string, object > CustomClaims
Gets the custom claims set on this user, as a non-null dictionary.
Possibly empty.
Disabled
bool Disabled
Gets a value indicating whether the user account is disabled or not.
DisplayName
string DisplayName
Gets the user's display name, if available.
Otherwise null.
Email
string Email
Gets the user's email address, if available.
Otherwise null.
EmailVerified
bool EmailVerified
Gets a value indicating whether the user's email address is verified or not.
PhoneNumber
string PhoneNumber
Gets the user's phone number, if available.
Otherwise null.
PhotoUrl
string PhotoUrl
Gets the user's photo URL, if available.
Otherwise null.
ProviderData
IUserInfo[] ProviderData
Gets a non-null array of provider data for this user.
Possibly empty.
TenantId
string TenantId
Gets the user's tenant ID, if available.
Otherwise null.
TokensValidAfterTimestamp
DateTime TokensValidAfterTimestamp
Gets a timestamp that indicates the earliest point in time at which a valid ID token could have been issued to this user.
Tokens issued prior to this timestamp are considered invalid.
Uid
string Uid
Gets the user ID of this user.
UserMetadata UserMetaData
Gets additional user metadata.
This is guaranteed not to be null.
Public attributes
ProviderId
string ProviderId => UserRecord.DefaultProviderId
Gets the ID of the identity provider.
This returns the constant value firebase.
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.UserRecord Class Reference\n\nFirebaseAdmin.Auth.UserRecord\n=============================\n\nContains metadata associated with a Firebase user account.\n\nSummary\n-------\n\nInstances of this class are immutable and thread safe.\n\n### Inheritance\n\nInherits from: [FirebaseAdmin.Auth.IUserInfo](/docs/reference/admin/dotnet/interface/firebase-admin/auth/i-user-info) \nDirect Known Subclasses:[FirebaseAdmin.Auth.ExportedUserRecord](/docs/reference/admin/dotnet/class/firebase-admin/auth/exported-user-record)\n\n| ### Properties ||\n|----------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [CustomClaims](#class_firebase_admin_1_1_auth_1_1_user_record_1ad70121e29831c38ad51d37f061292984) | `IReadOnlyDictionary\u003c string, object \u003e` Gets the custom claims set on this user, as a non-null dictionary. |\n| [Disabled](#class_firebase_admin_1_1_auth_1_1_user_record_1addd16ecfe2150706b5e3e2a817c29236) | `bool` Gets a value indicating whether the user account is disabled or not. |\n| [DisplayName](#class_firebase_admin_1_1_auth_1_1_user_record_1aa73515b57c739e2310fdc75de2b7bb76) | `string` Gets the user's display name, if available. |\n| [Email](#class_firebase_admin_1_1_auth_1_1_user_record_1a01393283c59e2239e0e33cb98ed5f655) | `string` Gets the user's email address, if available. |\n| [EmailVerified](#class_firebase_admin_1_1_auth_1_1_user_record_1a488689d2bcd278fbdb657b165905f6de) | `bool` Gets a value indicating whether the user's email address is verified or not. |\n| [PhoneNumber](#class_firebase_admin_1_1_auth_1_1_user_record_1a7f8710620c2804cc1f992b71ab91f089) | `string` Gets the user's phone number, if available. |\n| [PhotoUrl](#class_firebase_admin_1_1_auth_1_1_user_record_1aa4126ec184f76a739493635a67b4fdd2) | `string` Gets the user's photo URL, if available. |\n| [ProviderData](#class_firebase_admin_1_1_auth_1_1_user_record_1af1a2c4393e1558ef133e35f63dc973cb) | [IUserInfo](/docs/reference/admin/dotnet/interface/firebase-admin/auth/i-user-info#interface_firebase_admin_1_1_auth_1_1_i_user_info)`[]` Gets a non-null array of provider data for this user. |\n| [TenantId](#class_firebase_admin_1_1_auth_1_1_user_record_1af08996c402bca0eb49306bf7dcba1b76) | `string` Gets the user's tenant ID, if available. |\n| [TokensValidAfterTimestamp](#class_firebase_admin_1_1_auth_1_1_user_record_1a5bfa488082ceeae8e8b7c3305715c1b4) | `DateTime` Gets a timestamp that indicates the earliest point in time at which a valid ID token could have been issued to this user. |\n| [Uid](#class_firebase_admin_1_1_auth_1_1_user_record_1a06baab9fd2a7fb71eaeb0b17ad0d3f87) | `string` Gets the user ID of this user. |\n| [UserMetaData](#class_firebase_admin_1_1_auth_1_1_user_record_1aec0b8e14c32401b46b1737744a171157) | [UserMetadata](/docs/reference/admin/dotnet/class/firebase-admin/auth/user-metadata#class_firebase_admin_1_1_auth_1_1_user_metadata) Gets additional user metadata. |\n\n| ### Public attributes ||\n|-----------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|\n| [ProviderId](#class_firebase_admin_1_1_auth_1_1_user_record_1a84ae333acb8346863f1b7a94fc398835)` =\u003e UserRecord.DefaultProviderId` | `string` Gets the ID of the identity provider. |\n\nProperties\n----------\n\n### CustomClaims\n\n```text\nIReadOnlyDictionary\u003c string, object \u003e CustomClaims\n``` \nGets the custom claims set on this user, as a non-null dictionary.\n\nPossibly empty. \n\n### Disabled\n\n```text\nbool Disabled\n``` \nGets a value indicating whether the user account is disabled or not. \n\n### DisplayName\n\n```text\nstring DisplayName\n``` \nGets the user's display name, if available.\n\nOtherwise null. \n\n### Email\n\n```text\nstring Email\n``` \nGets the user's email address, if available.\n\nOtherwise null. \n\n### EmailVerified\n\n```text\nbool EmailVerified\n``` \nGets a value indicating whether the user's email address is verified or not. \n\n### PhoneNumber\n\n```text\nstring PhoneNumber\n``` \nGets the user's phone number, if available.\n\nOtherwise null. \n\n### PhotoUrl\n\n```text\nstring PhotoUrl\n``` \nGets the user's photo URL, if available.\n\nOtherwise null. \n\n### ProviderData\n\n```text\nIUserInfo[] ProviderData\n``` \nGets a non-null array of provider data for this user.\n\nPossibly empty. \n\n### TenantId\n\n```text\nstring TenantId\n``` \nGets the user's tenant ID, if available.\n\nOtherwise null. \n\n### TokensValidAfterTimestamp\n\n```text\nDateTime TokensValidAfterTimestamp\n``` \nGets a timestamp that indicates the earliest point in time at which a valid ID token could have been issued to this user.\n\nTokens issued prior to this timestamp are considered invalid. \n\n### Uid\n\n```text\nstring Uid\n``` \nGets the user ID of this user. \n\n### UserMetaData\n\n```text\nUserMetadata UserMetaData\n``` \nGets additional user metadata.\n\nThis is guaranteed not to be null.\n\nPublic attributes\n-----------------\n\n### ProviderId\n\n```text\nstring ProviderId =\u003e UserRecord.DefaultProviderId\n``` \nGets the ID of the identity provider.\n\nThis returns the constant value `firebase`."]]
