REST Resource: projects.databases.userCreds

Resource: UserCreds

A Cloud Firestore User Creds.

JSON representation
{"name":string,"createTime":string,"updateTime":string,"state":enum (State),"securePassword":string,// Union fieldUserCredsIdentity can be only one of the following:"resourceIdentity":{object (ResourceIdentity)}// End of list of possible types for union fieldUserCredsIdentity.}
Fields
name

string

Identifier. The resource name of the UserCreds. Format:projects/{project}/databases/{database}/userCreds/{userCreds}

createTime

string (Timestamp format)

Output only. The time the user creds were created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z" or"2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. The time the user creds were last updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z" or"2014-10-02T15:01:23+05:30".

state

enum (State)

Output only. Whether the user creds are enabled or disabled. Defaults to ENABLED on creation.

securePassword

string

Output only. The plaintext server-generated password for the user creds. Only populated in responses for userCreds.create and userCreds.resetPassword.

Union fieldUserCredsIdentity. Identity associated with this User Creds.UserCredsIdentity can be only one of the following:
resourceIdentity

object (ResourceIdentity)

Resource Identity descriptor.

State

The state of the user creds (ENABLED or DISABLED).

Enums
STATE_UNSPECIFIEDThe default value. Should not be used.
ENABLEDThe user creds are enabled.
DISABLEDThe user creds are disabled.

ResourceIdentity

Describes a Resource Identity principal.

JSON representation
{"principal":string}
Fields
principal

string

Output only. Principal identifier string. See:https://cloud.google.com/iam/docs/principal-identifiers

Methods

create

 Create a user creds.

delete

 Deletes a user creds.

disable

 Disables a user creds.

enable

 Enables a user creds.

get

 Gets a user creds resource.

list

 List all user creds in the database.

resetPassword

 Resets the password of a user creds.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-08-26 UTC.