user_creds

Creates, updates, deletes, gets or lists a user_creds resource.

Overview

Name	user_creds
Type	Resource
Id	google.firestore.user_creds

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the UserCreds. Format: projects/{project}/databases/{database}/userCreds/{user_creds}
createTime	string (google-datetime)	Output only. The time the user creds were created.
resourceIdentity	object	Resource Identity descriptor. (id: GoogleFirestoreAdminV1ResourceIdentity)
securePassword	string	Output only. The plaintext server-generated password for the user creds. Only populated in responses for CreateUserCreds and ResetUserPassword.
state	string	Output only. Whether the user creds are enabled or disabled. Defaults to ENABLED on creation.
updateTime	string (google-datetime)	Output only. The time the user creds were last updated.

list

Successful response

Name	Datatype	Description
userCreds	array	The user creds for the database.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, databasesId, userCredsId		Gets a user creds resource. Note that the returned resource does not contain the secret value itself.
list	select	projectsId, databasesId		List all user creds in the database. Note that the returned resource does not contain the secret value itself.
create	insert	projectsId, databasesId	userCredsId	Create a user creds.
delete	delete	projectsId, databasesId, userCredsId		Deletes a user creds.
enable	exec	projectsId, databasesId, userCredsId		Enables a user creds. No-op if the user creds are already enabled.
disable	exec	projectsId, databasesId, userCredsId		Disables a user creds. No-op if the user creds are already disabled.
reset_password	exec	projectsId, databasesId, userCredsId		Resets the password of a user creds.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
databasesId	string
projectsId	string
userCredsId	string
userCredsId	string

SELECT examples

get

Gets a user creds resource. Note that the returned resource does not contain the secret value itself.

SELECT
name,
createTime,
resourceIdentity,
securePassword,
state,
updateTime
FROM google.firestore.user_creds
WHERE projectsId = '{{ projectsId }}' -- required
AND databasesId = '{{ databasesId }}' -- required
AND userCredsId = '{{ userCredsId }}' -- required;

list

List all user creds in the database. Note that the returned resource does not contain the secret value itself.

SELECT
userCreds
FROM google.firestore.user_creds
WHERE projectsId = '{{ projectsId }}' -- required
AND databasesId = '{{ databasesId }}' -- required;

INSERT examples

create

Create a user creds.

INSERT INTO google.firestore.user_creds (
data__name,
data__resourceIdentity,
projectsId,
databasesId,
userCredsId
)
SELECT 
'{{ name }}',
'{{ resourceIdentity }}',
'{{ projectsId }}',
'{{ databasesId }}',
'{{ userCredsId }}'
RETURNING
name,
createTime,
resourceIdentity,
securePassword,
state,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: user_creds
  props:
    - name: projectsId
      value: string
      description: Required parameter for the user_creds resource.
    - name: databasesId
      value: string
      description: Required parameter for the user_creds resource.
    - name: name
      value: string
      description: >
        Identifier. The resource name of the UserCreds. Format: `projects/{project}/databases/{database}/userCreds/{user_creds}`
        
    - name: resourceIdentity
      value: object
      description: >
        Resource Identity descriptor.
        
    - name: userCredsId
      value: string

DELETE examples

delete

Deletes a user creds.

DELETE FROM google.firestore.user_creds
WHERE projectsId = '{{ projectsId }}' --required
AND databasesId = '{{ databasesId }}' --required
AND userCredsId = '{{ userCredsId }}' --required;

Lifecycle Methods

enable

Enables a user creds. No-op if the user creds are already enabled.

EXEC google.firestore.user_creds.enable 
@projectsId='{{ projectsId }}' --required, 
@databasesId='{{ databasesId }}' --required, 
@userCredsId='{{ userCredsId }}' --required;

disable

Disables a user creds. No-op if the user creds are already disabled.

EXEC google.firestore.user_creds.disable 
@projectsId='{{ projectsId }}' --required, 
@databasesId='{{ databasesId }}' --required, 
@userCredsId='{{ userCredsId }}' --required;

reset_password

Resets the password of a user creds.

EXEC google.firestore.user_creds.reset_password 
@projectsId='{{ projectsId }}' --required, 
@databasesId='{{ databasesId }}' --required, 
@userCredsId='{{ userCredsId }}' --required;