Debian Codegraph @

docs/dyn/firestore_v1.projects.databases.userCreds.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <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>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#create">create(parent, body=None, userCredsId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Create a user creds.</p>
83 <p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85 <p class="firstline">Deletes a user creds.</p>
86 <p class="toc_element">
87 <code><a href="#disable">disable(name, body=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Disables a user creds. No-op if the user creds are already disabled.</p>
89 <p class="toc_element">
90 <code><a href="#enable">enable(name, body=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Enables a user creds. No-op if the user creds are already enabled.</p>
92 <p class="toc_element">
93 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
94 <p class="firstline">Gets a user creds resource. Note that the returned resource does not contain the secret value itself.</p>
95 <p class="toc_element">
96 <code><a href="#list">list(parent, x__xgafv=None)</a></code></p>
97 <p class="firstline">List all user creds in the database. Note that the returned resource does not contain the secret value itself.</p>
98 <p class="toc_element">
99 <code><a href="#resetPassword">resetPassword(name, body=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Resets the password of a user creds.</p>
101 <h3>Method Details</h3>
102 <div class="method">
103 <code class="details" id="close">close()</code>
104 <pre>Close httplib2 connections.</pre>
105 </div>
106
107 <div class="method">
108 <code class="details" id="create">create(parent, body=None, userCredsId=None, x__xgafv=None)</code>
109 <pre>Create a user creds.
110
111 Args:
112 parent: string, Required. A parent name of the form `projects/{project_id}/databases/{database_id}` (required)
113 body: object, The request body.
114 The object takes the form of:
115
116 { # A Cloud Firestore User Creds.
117 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the user creds were created.
118 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the UserCreds. Format: `projects/{project}/databases/{database}/userCreds/{user_creds}`
119 &quot;resourceIdentity&quot;: { # Describes a Resource Identity principal. # Resource Identity descriptor.
120 &quot;principal&quot;: &quot;A String&quot;, # Output only. Principal identifier string. See: https://cloud.google.com/iam/docs/principal-identifiers
121 },
122 &quot;securePassword&quot;: &quot;A String&quot;, # Output only. The plaintext server-generated password for the user creds. Only populated in responses for CreateUserCreds and ResetUserPassword.
123 &quot;state&quot;: &quot;A String&quot;, # Output only. Whether the user creds are enabled or disabled. Defaults to ENABLED on creation.
124 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the user creds were last updated.
125 }
126
127 userCredsId: string, Required. The ID to use for the user creds, which will become the final component of the user creds&#x27;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}/.
128 x__xgafv: string, V1 error format.
129 Allowed values
130 1 - v1 error format
131 2 - v2 error format
132
133 Returns:
134 An object of the form:
135
136 { # A Cloud Firestore User Creds.
137 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the user creds were created.
138 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the UserCreds. Format: `projects/{project}/databases/{database}/userCreds/{user_creds}`
139 &quot;resourceIdentity&quot;: { # Describes a Resource Identity principal. # Resource Identity descriptor.
140 &quot;principal&quot;: &quot;A String&quot;, # Output only. Principal identifier string. See: https://cloud.google.com/iam/docs/principal-identifiers
141 },
142 &quot;securePassword&quot;: &quot;A String&quot;, # Output only. The plaintext server-generated password for the user creds. Only populated in responses for CreateUserCreds and ResetUserPassword.
143 &quot;state&quot;: &quot;A String&quot;, # Output only. Whether the user creds are enabled or disabled. Defaults to ENABLED on creation.
144 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the user creds were last updated.
145 }</pre>
146 </div>
147
148 <div class="method">
149 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
150 <pre>Deletes a user creds.
151
152 Args:
153 name: string, Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}` (required)
154 x__xgafv: string, V1 error format.
155 Allowed values
156 1 - v1 error format
157 2 - v2 error format
158
159 Returns:
160 An object of the form:
161
162 { # 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); }
163 }</pre>
164 </div>
165
166 <div class="method">
167 <code class="details" id="disable">disable(name, body=None, x__xgafv=None)</code>
168 <pre>Disables a user creds. No-op if the user creds are already disabled.
169
170 Args:
171 name: string, Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}` (required)
172 body: object, The request body.
173 The object takes the form of:
174
175 { # The request for FirestoreAdmin.DisableUserCreds.
176 }
177
178 x__xgafv: string, V1 error format.
179 Allowed values
180 1 - v1 error format
181 2 - v2 error format
182
183 Returns:
184 An object of the form:
185
186 { # A Cloud Firestore User Creds.
187 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the user creds were created.
188 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the UserCreds. Format: `projects/{project}/databases/{database}/userCreds/{user_creds}`
189 &quot;resourceIdentity&quot;: { # Describes a Resource Identity principal. # Resource Identity descriptor.
190 &quot;principal&quot;: &quot;A String&quot;, # Output only. Principal identifier string. See: https://cloud.google.com/iam/docs/principal-identifiers
191 },
192 &quot;securePassword&quot;: &quot;A String&quot;, # Output only. The plaintext server-generated password for the user creds. Only populated in responses for CreateUserCreds and ResetUserPassword.
193 &quot;state&quot;: &quot;A String&quot;, # Output only. Whether the user creds are enabled or disabled. Defaults to ENABLED on creation.
194 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the user creds were last updated.
195 }</pre>
196 </div>
197
198 <div class="method">
199 <code class="details" id="enable">enable(name, body=None, x__xgafv=None)</code>
200 <pre>Enables a user creds. No-op if the user creds are already enabled.
201
202 Args:
203 name: string, Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}` (required)
204 body: object, The request body.
205 The object takes the form of:
206
207 { # The request for FirestoreAdmin.EnableUserCreds.
208 }
209
210 x__xgafv: string, V1 error format.
211 Allowed values
212 1 - v1 error format
213 2 - v2 error format
214
215 Returns:
216 An object of the form:
217
218 { # A Cloud Firestore User Creds.
219 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the user creds were created.
220 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the UserCreds. Format: `projects/{project}/databases/{database}/userCreds/{user_creds}`
221 &quot;resourceIdentity&quot;: { # Describes a Resource Identity principal. # Resource Identity descriptor.
222 &quot;principal&quot;: &quot;A String&quot;, # Output only. Principal identifier string. See: https://cloud.google.com/iam/docs/principal-identifiers
223 },
224 &quot;securePassword&quot;: &quot;A String&quot;, # Output only. The plaintext server-generated password for the user creds. Only populated in responses for CreateUserCreds and ResetUserPassword.
225 &quot;state&quot;: &quot;A String&quot;, # Output only. Whether the user creds are enabled or disabled. Defaults to ENABLED on creation.
226 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the user creds were last updated.
227 }</pre>
228 </div>
229
230 <div class="method">
231 <code class="details" id="get">get(name, x__xgafv=None)</code>
232 <pre>Gets a user creds resource. Note that the returned resource does not contain the secret value itself.
233
234 Args:
235 name: string, Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}` (required)
236 x__xgafv: string, V1 error format.
237 Allowed values
238 1 - v1 error format
239 2 - v2 error format
240
241 Returns:
242 An object of the form:
243
244 { # A Cloud Firestore User Creds.
245 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the user creds were created.
246 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the UserCreds. Format: `projects/{project}/databases/{database}/userCreds/{user_creds}`
247 &quot;resourceIdentity&quot;: { # Describes a Resource Identity principal. # Resource Identity descriptor.
248 &quot;principal&quot;: &quot;A String&quot;, # Output only. Principal identifier string. See: https://cloud.google.com/iam/docs/principal-identifiers
249 },
250 &quot;securePassword&quot;: &quot;A String&quot;, # Output only. The plaintext server-generated password for the user creds. Only populated in responses for CreateUserCreds and ResetUserPassword.
251 &quot;state&quot;: &quot;A String&quot;, # Output only. Whether the user creds are enabled or disabled. Defaults to ENABLED on creation.
252 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the user creds were last updated.
253 }</pre>
254 </div>
255
256 <div class="method">
257 <code class="details" id="list">list(parent, x__xgafv=None)</code>
258 <pre>List all user creds in the database. Note that the returned resource does not contain the secret value itself.
259
260 Args:
261 parent: string, Required. A parent database name of the form `projects/{project_id}/databases/{database_id}` (required)
262 x__xgafv: string, V1 error format.
263 Allowed values
264 1 - v1 error format
265 2 - v2 error format
266
267 Returns:
268 An object of the form:
269
270 { # The response for FirestoreAdmin.ListUserCreds.
271 &quot;userCreds&quot;: [ # The user creds for the database.
272 { # A Cloud Firestore User Creds.
273 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the user creds were created.
274 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the UserCreds. Format: `projects/{project}/databases/{database}/userCreds/{user_creds}`
275 &quot;resourceIdentity&quot;: { # Describes a Resource Identity principal. # Resource Identity descriptor.
276 &quot;principal&quot;: &quot;A String&quot;, # Output only. Principal identifier string. See: https://cloud.google.com/iam/docs/principal-identifiers
277 },
278 &quot;securePassword&quot;: &quot;A String&quot;, # Output only. The plaintext server-generated password for the user creds. Only populated in responses for CreateUserCreds and ResetUserPassword.
279 &quot;state&quot;: &quot;A String&quot;, # Output only. Whether the user creds are enabled or disabled. Defaults to ENABLED on creation.
280 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the user creds were last updated.
281 },
282 ],
283 }</pre>
284 </div>
285
286 <div class="method">
287 <code class="details" id="resetPassword">resetPassword(name, body=None, x__xgafv=None)</code>
288 <pre>Resets the password of a user creds.
289
290 Args:
291 name: string, Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}` (required)
292 body: object, The request body.
293 The object takes the form of:
294
295 { # The request for FirestoreAdmin.ResetUserPassword.
296 }
297
298 x__xgafv: string, V1 error format.
299 Allowed values
300 1 - v1 error format
301 2 - v2 error format
302
303 Returns:
304 An object of the form:
305
306 { # A Cloud Firestore User Creds.
307 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the user creds were created.
308 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the UserCreds. Format: `projects/{project}/databases/{database}/userCreds/{user_creds}`
309 &quot;resourceIdentity&quot;: { # Describes a Resource Identity principal. # Resource Identity descriptor.
310 &quot;principal&quot;: &quot;A String&quot;, # Output only. Principal identifier string. See: https://cloud.google.com/iam/docs/principal-identifiers
311 },
312 &quot;securePassword&quot;: &quot;A String&quot;, # Output only. The plaintext server-generated password for the user creds. Only populated in responses for CreateUserCreds and ResetUserPassword.
313 &quot;state&quot;: &quot;A String&quot;, # Output only. Whether the user creds are enabled or disabled. Defaults to ENABLED on creation.
314 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the user creds were last updated.
315 }</pre>
316 </div>
317
318 </body></html>