| <html><body> | |
| <style> | |
| body, h1, h2, h3, div, span, p, pre, a { | |
| margin: 0; | |
| padding: 0; | |
| border: 0; | |
| font-weight: inherit; | |
| font-style: inherit; | |
| font-size: 100%; | |
| font-family: inherit; | |
| vertical-align: baseline; | |
| } | |
| body { | |
| font-size: 13px; | |
| padding: 1em; | |
| } | |
| h1 { | |
| font-size: 26px; | |
| margin-bottom: 1em; | |
| } | |
| h2 { | |
| font-size: 24px; | |
| margin-bottom: 1em; | |
| } | |
| h3 { | |
| font-size: 20px; | |
| margin-bottom: 1em; | |
| margin-top: 1em; | |
| } | |
| pre, code { | |
| line-height: 1.5; | |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; | |
| } | |
| pre { | |
| margin-top: 0.5em; | |
| } | |
| h1, h2, h3, p { | |
| font-family: Arial, sans serif; | |
| } | |
| h1, h2, h3 { | |
| border-bottom: solid #CCC 1px; | |
| } | |
| .toc_element { | |
| margin-top: 0.5em; | |
| } | |
| .firstline { | |
| margin-left: 2 em; | |
| } | |
| .method { | |
| margin-top: 1em; | |
| border: solid 1px #CCC; | |
| padding: 1em; | |
| background: #EEE; | |
| } | |
| .details { | |
| font-weight: bold; | |
| font-size: 14px; | |
| } | |
| </style> | |
| <h1><a href="firestore_v1.html">Cloud Firestore API</a> . <a href="firestore_v1.projects.html">projects</a> . <a href="firestore_v1.projects.databases.html">databases</a> . <a href="firestore_v1.projects.databases.userCreds.html">userCreds</a></h1> | |
| <h2>Instance Methods</h2> | |
| <p class="toc_element"> | |
| <code><a href="#close">close()</a></code></p> | |
| <p class="firstline">Close httplib2 connections.</p> | |
| <p class="toc_element"> | |
| <code><a href="#create">create(parent, body=None, userCredsId=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Create a user creds.</p> | |
| <p class="toc_element"> | |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Deletes a user creds.</p> | |
| <p class="toc_element"> | |
| <code><a href="#disable">disable(name, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Disables a user creds. No-op if the user creds are already disabled.</p> | |
| <p class="toc_element"> | |
| <code><a href="#enable">enable(name, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Enables a user creds. No-op if the user creds are already enabled.</p> | |
| <p class="toc_element"> | |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Gets a user creds resource. Note that the returned resource does not contain the secret value itself.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list">list(parent, x__xgafv=None)</a></code></p> | |
| <p class="firstline">List all user creds in the database. Note that the returned resource does not contain the secret value itself.</p> | |
| <p class="toc_element"> | |
| <code><a href="#resetPassword">resetPassword(name, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Resets the password of a user creds.</p> | |
| <h3>Method Details</h3> | |
| <div class="method"> | |
| <code class="details" id="close">close()</code> | |
| <pre>Close httplib2 connections.</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="create">create(parent, body=None, userCredsId=None, x__xgafv=None)</code> | |
| <pre>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. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> | |
| <pre>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); } | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="disable">disable(name, body=None, x__xgafv=None)</code> | |
| <pre>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. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="enable">enable(name, body=None, x__xgafv=None)</code> | |
| <pre>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. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="get">get(name, x__xgafv=None)</code> | |
| <pre>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. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list">list(parent, x__xgafv=None)</code> | |
| <pre>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. | |
| }, | |
| ], | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="resetPassword">resetPassword(name, body=None, x__xgafv=None)</code> | |
| <pre>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. | |
| }</pre> | |
| </div> | |
| </body></html> |