Cloud Firestore API (firestore:v1)

▼ ▲ firestore.projects.databases.userCreds.create

Path : v1/{+parent}/userCreds

Flat Path : v1/projects/{projectsId}/databases/{databasesId}/userCreds

HTTP Method : POST

Parameters :

parent

Description : Required. A parent name of the form `projects/{project_id}/databases/{database_id}`

Pattern : ^projects/[^/]+/databases/[^/]+$

Location : path

Required : Yes

Type : string

userCredsId

Description : Required. The ID to use for the user creds, which will become the final component of the user creds's resource name. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.

Location : query

Type : string

Parameter Order : parent

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/datastore

Description : Create a user creds.

▼ ▲ firestore.projects.databases.userCreds.get

Path : v1/{+name}

Flat Path : v1/projects/{projectsId}/databases/{databasesId}/userCreds/{userCredsId}

HTTP Method : GET

Parameters :

name

Description : Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}`

Pattern : ^projects/[^/]+/databases/[^/]+/userCreds/[^/]+$

Location : path

Required : Yes

Type : string

Parameter Order : name

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/datastore

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

▼ ▲ firestore.projects.databases.userCreds.list

Path : v1/{+parent}/userCreds

Flat Path : v1/projects/{projectsId}/databases/{databasesId}/userCreds

HTTP Method : GET

Parameters :

parent

Description : Required. A parent database name of the form `projects/{project_id}/databases/{database_id}`

Pattern : ^projects/[^/]+/databases/[^/]+$

Location : path

Required : Yes

Type : string

Parameter Order : parent

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/datastore

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

▼ ▲ firestore.projects.databases.userCreds.enable

Path : v1/{+name}:enable

Flat Path : v1/projects/{projectsId}/databases/{databasesId}/userCreds/{userCredsId}:enable

HTTP Method : POST

Parameters :

name

Description : Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}`

Pattern : ^projects/[^/]+/databases/[^/]+/userCreds/[^/]+$

Location : path

Required : Yes

Type : string

Parameter Order : name

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/datastore

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

▼ ▲ firestore.projects.databases.userCreds.disable

Path : v1/{+name}:disable

Flat Path : v1/projects/{projectsId}/databases/{databasesId}/userCreds/{userCredsId}:disable

HTTP Method : POST

Parameters :

name

Description : Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}`

Pattern : ^projects/[^/]+/databases/[^/]+/userCreds/[^/]+$

Location : path

Required : Yes

Type : string

Parameter Order : name

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/datastore

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

▼ ▲ firestore.projects.databases.userCreds.resetPassword

Path : v1/{+name}:resetPassword

Flat Path : v1/projects/{projectsId}/databases/{databasesId}/userCreds/{userCredsId}:resetPassword

HTTP Method : POST

Parameters :

name

Description : Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}`

Pattern : ^projects/[^/]+/databases/[^/]+/userCreds/[^/]+$

Location : path

Required : Yes

Type : string

Parameter Order : name

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/datastore

Description : Resets the password of a user creds.

▼ ▲ firestore.projects.databases.userCreds.delete

Path : v1/{+name}

Flat Path : v1/projects/{projectsId}/databases/{databasesId}/userCreds/{userCredsId}

HTTP Method : DELETE

Parameters :

name

Description : Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}`

Pattern : ^projects/[^/]+/databases/[^/]+/userCreds/[^/]+$

Location : path

Required : Yes

Type : string

Parameter Order : name

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/datastore

Description : Deletes a user creds.

▼ ▲ firestore.projects.locations.list

Parameters :

extraLocationTypes

Description : Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.

Location : query

Repeated : Yes

Type : string