Cloud Firestore API . projects . databases . userCreds

close()

Close httplib2 connections.

create(parent, body=None, userCredsId=None, x__xgafv=None)

Create a user creds.

Args:
  parent: string, Required. A parent name of the form `projects/{project_id}/databases/{database_id}` (required)
  body: object, The request body.
    The object takes the form of:

{ # A Cloud Firestore User Creds.
  "createTime": "A String", # Output only. The time the user creds were created.
  "name": "A String", # Identifier. The resource name of the UserCreds. Format: `projects/{project}/databases/{database}/userCreds/{user_creds}`
  "resourceIdentity": { # Describes a Resource Identity principal. # Resource Identity descriptor.
    "principal": "A String", # Output only. Principal identifier string. See: https://cloud.google.com/iam/docs/principal-identifiers
  },
  "securePassword": "A String", # Output only. The plaintext server-generated password for the user creds. Only populated in responses for CreateUserCreds and ResetUserPassword.
  "state": "A String", # Output only. Whether the user creds are enabled or disabled. Defaults to ENABLED on creation.
  "updateTime": "A String", # Output only. The time the user creds were last updated.
}

  userCredsId: string, 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}/.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Cloud Firestore User Creds.
  "createTime": "A String", # Output only. The time the user creds were created.
  "name": "A String", # Identifier. The resource name of the UserCreds. Format: `projects/{project}/databases/{database}/userCreds/{user_creds}`
  "resourceIdentity": { # Describes a Resource Identity principal. # Resource Identity descriptor.
    "principal": "A String", # Output only. Principal identifier string. See: https://cloud.google.com/iam/docs/principal-identifiers
  },
  "securePassword": "A String", # Output only. The plaintext server-generated password for the user creds. Only populated in responses for CreateUserCreds and ResetUserPassword.
  "state": "A String", # Output only. Whether the user creds are enabled or disabled. Defaults to ENABLED on creation.
  "updateTime": "A String", # Output only. The time the user creds were last updated.
}

delete(name, x__xgafv=None)

Deletes a user creds.

Args:
  name: string, Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

disable(name, body=None, x__xgafv=None)

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

Args:
  name: string, Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}` (required)
  body: object, The request body.
    The object takes the form of:

{ # The request for FirestoreAdmin.DisableUserCreds.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Cloud Firestore User Creds.
  "createTime": "A String", # Output only. The time the user creds were created.
  "name": "A String", # Identifier. The resource name of the UserCreds. Format: `projects/{project}/databases/{database}/userCreds/{user_creds}`
  "resourceIdentity": { # Describes a Resource Identity principal. # Resource Identity descriptor.
    "principal": "A String", # Output only. Principal identifier string. See: https://cloud.google.com/iam/docs/principal-identifiers
  },
  "securePassword": "A String", # Output only. The plaintext server-generated password for the user creds. Only populated in responses for CreateUserCreds and ResetUserPassword.
  "state": "A String", # Output only. Whether the user creds are enabled or disabled. Defaults to ENABLED on creation.
  "updateTime": "A String", # Output only. The time the user creds were last updated.
}

enable(name, body=None, x__xgafv=None)

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

Args:
  name: string, Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}` (required)
  body: object, The request body.
    The object takes the form of:

{ # The request for FirestoreAdmin.EnableUserCreds.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Cloud Firestore User Creds.
  "createTime": "A String", # Output only. The time the user creds were created.
  "name": "A String", # Identifier. The resource name of the UserCreds. Format: `projects/{project}/databases/{database}/userCreds/{user_creds}`
  "resourceIdentity": { # Describes a Resource Identity principal. # Resource Identity descriptor.
    "principal": "A String", # Output only. Principal identifier string. See: https://cloud.google.com/iam/docs/principal-identifiers
  },
  "securePassword": "A String", # Output only. The plaintext server-generated password for the user creds. Only populated in responses for CreateUserCreds and ResetUserPassword.
  "state": "A String", # Output only. Whether the user creds are enabled or disabled. Defaults to ENABLED on creation.
  "updateTime": "A String", # Output only. The time the user creds were last updated.
}

get(name, x__xgafv=None)

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

Args:
  name: string, Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Cloud Firestore User Creds.
  "createTime": "A String", # Output only. The time the user creds were created.
  "name": "A String", # Identifier. The resource name of the UserCreds. Format: `projects/{project}/databases/{database}/userCreds/{user_creds}`
  "resourceIdentity": { # Describes a Resource Identity principal. # Resource Identity descriptor.
    "principal": "A String", # Output only. Principal identifier string. See: https://cloud.google.com/iam/docs/principal-identifiers
  },
  "securePassword": "A String", # Output only. The plaintext server-generated password for the user creds. Only populated in responses for CreateUserCreds and ResetUserPassword.
  "state": "A String", # Output only. Whether the user creds are enabled or disabled. Defaults to ENABLED on creation.
  "updateTime": "A String", # Output only. The time the user creds were last updated.
}

list(parent, x__xgafv=None)

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

Args:
  parent: string, Required. A parent database name of the form `projects/{project_id}/databases/{database_id}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response for FirestoreAdmin.ListUserCreds.
  "userCreds": [ # The user creds for the database.
    { # A Cloud Firestore User Creds.
      "createTime": "A String", # Output only. The time the user creds were created.
      "name": "A String", # Identifier. The resource name of the UserCreds. Format: `projects/{project}/databases/{database}/userCreds/{user_creds}`
      "resourceIdentity": { # Describes a Resource Identity principal. # Resource Identity descriptor.
        "principal": "A String", # Output only. Principal identifier string. See: https://cloud.google.com/iam/docs/principal-identifiers
      },
      "securePassword": "A String", # Output only. The plaintext server-generated password for the user creds. Only populated in responses for CreateUserCreds and ResetUserPassword.
      "state": "A String", # Output only. Whether the user creds are enabled or disabled. Defaults to ENABLED on creation.
      "updateTime": "A String", # Output only. The time the user creds were last updated.
    },
  ],
}

resetPassword(name, body=None, x__xgafv=None)

Resets the password of a user creds.

Args:
  name: string, Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}` (required)
  body: object, The request body.
    The object takes the form of:

{ # The request for FirestoreAdmin.ResetUserPassword.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Cloud Firestore User Creds.
  "createTime": "A String", # Output only. The time the user creds were created.
  "name": "A String", # Identifier. The resource name of the UserCreds. Format: `projects/{project}/databases/{database}/userCreds/{user_creds}`
  "resourceIdentity": { # Describes a Resource Identity principal. # Resource Identity descriptor.
    "principal": "A String", # Output only. Principal identifier string. See: https://cloud.google.com/iam/docs/principal-identifiers
  },
  "securePassword": "A String", # Output only. The plaintext server-generated password for the user creds. Only populated in responses for CreateUserCreds and ResetUserPassword.
  "state": "A String", # Output only. Whether the user creds are enabled or disabled. Defaults to ENABLED on creation.
  "updateTime": "A String", # Output only. The time the user creds were last updated.
}