REST Resource: projects.databases.userCreds
Stay organized with collections
Save and categorize content based on your preferences.
Resource: UserCreds
A Cloud Firestore User Creds.
| JSON representation |
{
"name": string,
"createTime": string,
"updateTime": string,
"state": enum (State),
"securePassword": string,
// Union field UserCredsIdentity can be only one of the following:
"resourceIdentity": {
object (ResourceIdentity)
}
// End of list of possible types for union field UserCredsIdentity.
} |
| 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 field UserCredsIdentity. 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_UNSPECIFIED |
The default value. Should not be used. |
ENABLED |
The user creds are enabled. |
DISABLED |
The user creds are disabled. |
ResourceIdentity
Describes a Resource Identity principal.
| JSON representation |
{
"principal": string
} |
Methods |
|
|
Create a user creds. |
|
|
Deletes a user creds. |
|
|
Disables a user creds. |
|
|
Enables a user creds. |
|
|
Gets a user creds resource. |
|
|
List all user creds in the database. |
|
|
Resets the password of a user creds. |
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 2025-08-26 UTC.
[null,null,["Last updated 2025-08-26 UTC."],[],[],null,["# REST Resource: projects.databases.userCreds\n\nResource: UserCreds\n-------------------\n\nA Cloud Firestore User Creds.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"createTime\": string, \"updateTime\": string, \"state\": enum (/docs/firestore/reference/rest/v1/projects.databases.userCreds#State), \"securePassword\": string, // Union field `UserCredsIdentity` can be only one of the following: \"resourceIdentity\": { object (/docs/firestore/reference/rest/v1/projects.databases.userCreds#ResourceIdentity) } // End of list of possible types for union field `UserCredsIdentity`. } ``` |\n\n| Fields ||\n|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Identifier. The resource name of the UserCreds. Format: `projects/{project}/databases/{database}/userCreds/{userCreds}` |\n| `createTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Output only. The time the user creds were created. Uses RFC 3339, where generated output will always be Z-normalized and uses 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\"`. |\n| `updateTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Output only. The time the user creds were last updated. Uses RFC 3339, where generated output will always be Z-normalized and uses 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\"`. |\n| `state` | `enum (`[State](/docs/firestore/reference/rest/v1/projects.databases.userCreds#State)`)` Output only. Whether the user creds are enabled or disabled. Defaults to ENABLED on creation. |\n| `securePassword` | `string` Output only. The plaintext server-generated password for the user creds. Only populated in responses for userCreds.create and userCreds.resetPassword. |\n| Union field `UserCredsIdentity`. Identity associated with this User Creds. `UserCredsIdentity` can be only one of the following: ||\n| `resourceIdentity` | `object (`[ResourceIdentity](/docs/firestore/reference/rest/v1/projects.databases.userCreds#ResourceIdentity)`)` Resource Identity descriptor. |\n\nState\n-----\n\nThe state of the user creds (ENABLED or DISABLED).\n\n| Enums ||\n|---------------------|----------------------------------------|\n| `STATE_UNSPECIFIED` | The default value. Should not be used. |\n| `ENABLED` | The user creds are enabled. |\n| `DISABLED` | The user creds are disabled. |\n\nResourceIdentity\n----------------\n\nDescribes a Resource Identity principal.\n\n| JSON representation |\n|---------------------------------|\n| ``` { \"principal\": string } ``` |\n\n| Fields ||\n|-------------|-------------------------------------------------------------------------------------------------------------------|\n| `principal` | `string` Output only. Principal identifier string. See: \u003chttps://cloud.google.com/iam/docs/principal-identifiers\u003e |\n\n| Methods ------- ||\n|---------------------------------------------------------------------------------------------------|--------------------------------------|\n| ### [create](/docs/firestore/reference/rest/v1/projects.databases.userCreds/create) | Create a user creds. |\n| ### [delete](/docs/firestore/reference/rest/v1/projects.databases.userCreds/delete) | Deletes a user creds. |\n| ### [disable](/docs/firestore/reference/rest/v1/projects.databases.userCreds/disable) | Disables a user creds. |\n| ### [enable](/docs/firestore/reference/rest/v1/projects.databases.userCreds/enable) | Enables a user creds. |\n| ### [get](/docs/firestore/reference/rest/v1/projects.databases.userCreds/get) | Gets a user creds resource. |\n| ### [list](/docs/firestore/reference/rest/v1/projects.databases.userCreds/list) | List all user creds in the database. |\n| ### [resetPassword](/docs/firestore/reference/rest/v1/projects.databases.userCreds/resetPassword) | Resets the password of a user creds. |"]]
