1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
|
<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>
|
