UserInfo

JSON representation

An Identity Platform account's information.

JSON representation

JSON representation
{ "localId": string, "email": string, "displayName": string, "language": string, "photoUrl": string, "timeZone": string, "dateOfBirth": string, "passwordHash": string, "salt": string, "version": integer, "emailVerified": boolean, "passwordUpdatedAt": number, "providerUserInfo": [ { object (`ProviderUserInfo`) } ], "validSince": string, "disabled": boolean, "lastLoginAt": string, "createdAt": string, "screenName": string, "customAuth": boolean, "rawPassword": string, "phoneNumber": string, "customAttributes": string, "emailLinkSignin": boolean, "tenantId": string, "mfaInfo": [ { object (`MfaEnrollment`) } ], "initialEmail": string, "lastRefreshAt": string }

{
  "localId": string,
  "email": string,
  "displayName": string,
  "language": string,
  "photoUrl": string,
  "timeZone": string,
  "dateOfBirth": string,
  "passwordHash": string,
  "salt": string,
  "version": integer,
  "emailVerified": boolean,
  "passwordUpdatedAt": number,
  "providerUserInfo": [
    {
      object (ProviderUserInfo)
    }
  ],
  "validSince": string,
  "disabled": boolean,
  "lastLoginAt": string,
  "createdAt": string,
  "screenName": string,
  "customAuth": boolean,
  "rawPassword": string,
  "phoneNumber": string,
  "customAttributes": string,
  "emailLinkSignin": boolean,
  "tenantId": string,
  "mfaInfo": [
    {
      object (MfaEnrollment)
    }
  ],
  "initialEmail": string,
  "lastRefreshAt": string
}

Fields
`localId`	`string` Immutable. The unique ID of the account.
`email`	`string` The account's email address. The length of the email should be less than 256 characters and in the format of `name@domain.tld`. The email should also match the RFC 822 addr-spec.
`displayName`	`string` The display name of the account. This account attribute is not used by Identity Platform. It is available for informational purposes only.
`language`	`string` Output only. The language preference of the account. This account attribute is not used by Identity Platform. It is available for informational purposes only.
`photoUrl`	`string` The URL of the account's profile photo. This account attribute is not used by Identity Platform. It is available for informational purposes only.
`timeZone`	`string` Output only. The time zone preference of the account. This account attribute is not used by Identity Platform. It is available for informational purposes only.
`dateOfBirth`	`string` Output only. The date of birth set for the account. This account attribute is not used by Identity Platform. It is available for informational purposes only.
`passwordHash`	`string (bytes format)` The account's hashed password. Only accessible by requests bearing a Google OAuth2 credential with proper permissions. A base64-encoded string.
`salt`	`string (bytes format)` The account's password salt. Only accessible by requests bearing a Google OAuth2 credential with proper permissions. A base64-encoded string.
`version`	`integer` The version of the account's password. Only accessible by requests bearing a Google OAuth2 credential with proper permissions.
`emailVerified`	`boolean` Whether the account's email address has been verified.
`passwordUpdatedAt`	`number` The timestamp, in milliseconds from the epoch of 1970-01-01T00:00:00Z, when the account's password was last updated.
`providerUserInfo[]`	`object (ProviderUserInfo)` Information about the user as provided by various Identity Providers.
`validSince`	`string (int64 format)` Oldest timestamp, in seconds since epoch, that an ID token should be considered valid. All ID tokens issued before this time are considered invalid.
`disabled`	`boolean` Whether the account is disabled. Disabled accounts are inaccessible except for requests bearing a Google OAuth2 credential with proper permissions.
`lastLoginAt`	`string (int64 format)` The last time, in milliseconds from epoch, this account was logged into.
`createdAt`	`string (int64 format)` The time, in milliseconds from epoch, when the account was created.
`screenName`	`string` Output only. This account's screen name at Twitter or login name at GitHub.
`customAuth`	`boolean` Output only. Whether this account has been authenticated using accounts.signInWithCustomToken.
`rawPassword`	`string` Input only. Plain text password used to update a account's password. This field is only ever used as input in a request. Identity Platform uses cryptographically secure hashing when managing passwords and will never store or transmit a user's password in plain text.
`phoneNumber`	`string` The account's phone number.
`customAttributes`	`string` Custom claims to be added to any ID tokens minted for the account. Should be at most 1,000 characters in length and in valid JSON format.
`emailLinkSignin`	`boolean` Output only. Whether the account can authenticate with email link.
`tenantId`	`string` ID of the tenant this account belongs to. Only set if this account belongs to a tenant.
`mfaInfo[]`	`object (MfaEnrollment)` Information on which multi-factor authentication providers are enabled for this account.
`initialEmail`	`string` The first email address associated with this account. The account's initial email cannot be changed once set and is used to recover access to this account if lost via the RECOVER_EMAIL flow in accounts.sendOobCode. Should match the RFC 822 addr-spec.
`lastRefreshAt`	`string (Timestamp format)` Timestamp when an ID token was last minted for this account. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`.