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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
|
<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="iam_v1.html">Identity and Access Management (IAM) API</a> . <a href="iam_v1.projects.html">projects</a> . <a href="iam_v1.projects.locations.html">locations</a> . <a href="iam_v1.projects.locations.oauthClients.html">oauthClients</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="iam_v1.projects.locations.oauthClients.credentials.html">credentials()</a></code>
</p>
<p class="firstline">Returns the credentials Resource.</p>
<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, oauthClientId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new OauthClient. You cannot reuse the name of a deleted OauthClient until 30 days after deletion.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an OauthClient. You cannot use a deleted OauthClient. However, deletion does not revoke access tokens that have already been issued. They continue to grant access. Deletion does revoke refresh tokens that have already been issued. They cannot be used to renew an access token. If the OauthClient is undeleted, and the refresh tokens are not expired, they are valid for token exchange again. You can undelete an OauthClient for 30 days. After 30 days, deletion is permanent. You cannot update deleted OauthClients. However, you can view and list them.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an individual OauthClient.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all non-deleted OauthClients in a project. If `show_deleted` is set to `true`, then deleted OauthClients are also listed.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing OauthClient.</p>
<p class="toc_element">
<code><a href="#undelete">undelete(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Undeletes an OauthClient, as long as it was deleted fewer than 30 days ago.</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, oauthClientId=None, x__xgafv=None)</code>
<pre>Creates a new OauthClient. You cannot reuse the name of a deleted OauthClient until 30 days after deletion.
Args:
parent: string, Required. The parent resource to create the OauthClient in. The only supported location is `global`. (required)
body: object, The request body.
The object takes the form of:
{ # Represents an OauthClient. Used to access Google Cloud resources on behalf of a Workforce Identity Federation user by using OAuth 2.0 Protocol to obtain an access token from Google Cloud.
"allowedGrantTypes": [ # Required. The list of OAuth grant types is allowed for the OauthClient.
"A String",
],
"allowedRedirectUris": [ # Required. The list of redirect uris that is allowed to redirect back when authorization process is completed.
"A String",
],
"allowedScopes": [ # Required. The list of scopes that the OauthClient is allowed to request during OAuth flows. The following scopes are supported: * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. * `openid`: The OAuth client can associate you with your personal information on Google Cloud. * `email`: The OAuth client can read a federated identity's email address. * `groups`: The OAuth client can read a federated identity's groups.
"A String",
],
"clientId": "A String", # Output only. The system-generated OauthClient id.
"clientType": "A String", # Immutable. The type of OauthClient. Either public or private. For private clients, the client secret can be managed using the dedicated OauthClientCredential resource.
"description": "A String", # Optional. A user-specified description of the OauthClient. Cannot exceed 256 characters.
"disabled": True or False, # Optional. Whether the OauthClient is disabled. You cannot use a disabled OAuth client.
"displayName": "A String", # Optional. A user-specified display name of the OauthClient. Cannot exceed 32 characters.
"expireTime": "A String", # Output only. Time after which the OauthClient will be permanently purged and cannot be recovered.
"name": "A String", # Immutable. Identifier. The resource name of the OauthClient. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.
"state": "A String", # Output only. The state of the OauthClient.
}
oauthClientId: string, Required. The ID to use for the OauthClient, which becomes the final component of the resource name. This value should be a string of 6 to 63 lowercase letters, digits, or hyphens. It must start with a letter, and cannot have a trailing hyphen. The prefix `gcp-` is reserved for use by Google, and may not be specified.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents an OauthClient. Used to access Google Cloud resources on behalf of a Workforce Identity Federation user by using OAuth 2.0 Protocol to obtain an access token from Google Cloud.
"allowedGrantTypes": [ # Required. The list of OAuth grant types is allowed for the OauthClient.
"A String",
],
"allowedRedirectUris": [ # Required. The list of redirect uris that is allowed to redirect back when authorization process is completed.
"A String",
],
"allowedScopes": [ # Required. The list of scopes that the OauthClient is allowed to request during OAuth flows. The following scopes are supported: * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. * `openid`: The OAuth client can associate you with your personal information on Google Cloud. * `email`: The OAuth client can read a federated identity's email address. * `groups`: The OAuth client can read a federated identity's groups.
"A String",
],
"clientId": "A String", # Output only. The system-generated OauthClient id.
"clientType": "A String", # Immutable. The type of OauthClient. Either public or private. For private clients, the client secret can be managed using the dedicated OauthClientCredential resource.
"description": "A String", # Optional. A user-specified description of the OauthClient. Cannot exceed 256 characters.
"disabled": True or False, # Optional. Whether the OauthClient is disabled. You cannot use a disabled OAuth client.
"displayName": "A String", # Optional. A user-specified display name of the OauthClient. Cannot exceed 32 characters.
"expireTime": "A String", # Output only. Time after which the OauthClient will be permanently purged and cannot be recovered.
"name": "A String", # Immutable. Identifier. The resource name of the OauthClient. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.
"state": "A String", # Output only. The state of the OauthClient.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes an OauthClient. You cannot use a deleted OauthClient. However, deletion does not revoke access tokens that have already been issued. They continue to grant access. Deletion does revoke refresh tokens that have already been issued. They cannot be used to renew an access token. If the OauthClient is undeleted, and the refresh tokens are not expired, they are valid for token exchange again. You can undelete an OauthClient for 30 days. After 30 days, deletion is permanent. You cannot update deleted OauthClients. However, you can view and list them.
Args:
name: string, Required. The name of the OauthClient to delete. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents an OauthClient. Used to access Google Cloud resources on behalf of a Workforce Identity Federation user by using OAuth 2.0 Protocol to obtain an access token from Google Cloud.
"allowedGrantTypes": [ # Required. The list of OAuth grant types is allowed for the OauthClient.
"A String",
],
"allowedRedirectUris": [ # Required. The list of redirect uris that is allowed to redirect back when authorization process is completed.
"A String",
],
"allowedScopes": [ # Required. The list of scopes that the OauthClient is allowed to request during OAuth flows. The following scopes are supported: * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. * `openid`: The OAuth client can associate you with your personal information on Google Cloud. * `email`: The OAuth client can read a federated identity's email address. * `groups`: The OAuth client can read a federated identity's groups.
"A String",
],
"clientId": "A String", # Output only. The system-generated OauthClient id.
"clientType": "A String", # Immutable. The type of OauthClient. Either public or private. For private clients, the client secret can be managed using the dedicated OauthClientCredential resource.
"description": "A String", # Optional. A user-specified description of the OauthClient. Cannot exceed 256 characters.
"disabled": True or False, # Optional. Whether the OauthClient is disabled. You cannot use a disabled OAuth client.
"displayName": "A String", # Optional. A user-specified display name of the OauthClient. Cannot exceed 32 characters.
"expireTime": "A String", # Output only. Time after which the OauthClient will be permanently purged and cannot be recovered.
"name": "A String", # Immutable. Identifier. The resource name of the OauthClient. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.
"state": "A String", # Output only. The state of the OauthClient.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets an individual OauthClient.
Args:
name: string, Required. The name of the OauthClient to retrieve. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents an OauthClient. Used to access Google Cloud resources on behalf of a Workforce Identity Federation user by using OAuth 2.0 Protocol to obtain an access token from Google Cloud.
"allowedGrantTypes": [ # Required. The list of OAuth grant types is allowed for the OauthClient.
"A String",
],
"allowedRedirectUris": [ # Required. The list of redirect uris that is allowed to redirect back when authorization process is completed.
"A String",
],
"allowedScopes": [ # Required. The list of scopes that the OauthClient is allowed to request during OAuth flows. The following scopes are supported: * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. * `openid`: The OAuth client can associate you with your personal information on Google Cloud. * `email`: The OAuth client can read a federated identity's email address. * `groups`: The OAuth client can read a federated identity's groups.
"A String",
],
"clientId": "A String", # Output only. The system-generated OauthClient id.
"clientType": "A String", # Immutable. The type of OauthClient. Either public or private. For private clients, the client secret can be managed using the dedicated OauthClientCredential resource.
"description": "A String", # Optional. A user-specified description of the OauthClient. Cannot exceed 256 characters.
"disabled": True or False, # Optional. Whether the OauthClient is disabled. You cannot use a disabled OAuth client.
"displayName": "A String", # Optional. A user-specified display name of the OauthClient. Cannot exceed 32 characters.
"expireTime": "A String", # Output only. Time after which the OauthClient will be permanently purged and cannot be recovered.
"name": "A String", # Immutable. Identifier. The resource name of the OauthClient. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.
"state": "A String", # Output only. The state of the OauthClient.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)</code>
<pre>Lists all non-deleted OauthClients in a project. If `show_deleted` is set to `true`, then deleted OauthClients are also listed.
Args:
parent: string, Required. The parent to list OauthClients for. (required)
pageSize: integer, Optional. The maximum number of OauthClients to return. If unspecified, at most 50 OauthClients will be returned. The maximum value is 100; values above 100 are truncated to 100.
pageToken: string, Optional. A page token, received from a previous `ListOauthClients` call. Provide this to retrieve the subsequent page.
showDeleted: boolean, Optional. Whether to return soft-deleted OauthClients.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for ListOauthClients.
"nextPageToken": "A String", # Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"oauthClients": [ # A list of OauthClients.
{ # Represents an OauthClient. Used to access Google Cloud resources on behalf of a Workforce Identity Federation user by using OAuth 2.0 Protocol to obtain an access token from Google Cloud.
"allowedGrantTypes": [ # Required. The list of OAuth grant types is allowed for the OauthClient.
"A String",
],
"allowedRedirectUris": [ # Required. The list of redirect uris that is allowed to redirect back when authorization process is completed.
"A String",
],
"allowedScopes": [ # Required. The list of scopes that the OauthClient is allowed to request during OAuth flows. The following scopes are supported: * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. * `openid`: The OAuth client can associate you with your personal information on Google Cloud. * `email`: The OAuth client can read a federated identity's email address. * `groups`: The OAuth client can read a federated identity's groups.
"A String",
],
"clientId": "A String", # Output only. The system-generated OauthClient id.
"clientType": "A String", # Immutable. The type of OauthClient. Either public or private. For private clients, the client secret can be managed using the dedicated OauthClientCredential resource.
"description": "A String", # Optional. A user-specified description of the OauthClient. Cannot exceed 256 characters.
"disabled": True or False, # Optional. Whether the OauthClient is disabled. You cannot use a disabled OAuth client.
"displayName": "A String", # Optional. A user-specified display name of the OauthClient. Cannot exceed 32 characters.
"expireTime": "A String", # Output only. Time after which the OauthClient will be permanently purged and cannot be recovered.
"name": "A String", # Immutable. Identifier. The resource name of the OauthClient. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.
"state": "A String", # Output only. The state of the OauthClient.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates an existing OauthClient.
Args:
name: string, Immutable. Identifier. The resource name of the OauthClient. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`. (required)
body: object, The request body.
The object takes the form of:
{ # Represents an OauthClient. Used to access Google Cloud resources on behalf of a Workforce Identity Federation user by using OAuth 2.0 Protocol to obtain an access token from Google Cloud.
"allowedGrantTypes": [ # Required. The list of OAuth grant types is allowed for the OauthClient.
"A String",
],
"allowedRedirectUris": [ # Required. The list of redirect uris that is allowed to redirect back when authorization process is completed.
"A String",
],
"allowedScopes": [ # Required. The list of scopes that the OauthClient is allowed to request during OAuth flows. The following scopes are supported: * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. * `openid`: The OAuth client can associate you with your personal information on Google Cloud. * `email`: The OAuth client can read a federated identity's email address. * `groups`: The OAuth client can read a federated identity's groups.
"A String",
],
"clientId": "A String", # Output only. The system-generated OauthClient id.
"clientType": "A String", # Immutable. The type of OauthClient. Either public or private. For private clients, the client secret can be managed using the dedicated OauthClientCredential resource.
"description": "A String", # Optional. A user-specified description of the OauthClient. Cannot exceed 256 characters.
"disabled": True or False, # Optional. Whether the OauthClient is disabled. You cannot use a disabled OAuth client.
"displayName": "A String", # Optional. A user-specified display name of the OauthClient. Cannot exceed 32 characters.
"expireTime": "A String", # Output only. Time after which the OauthClient will be permanently purged and cannot be recovered.
"name": "A String", # Immutable. Identifier. The resource name of the OauthClient. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.
"state": "A String", # Output only. The state of the OauthClient.
}
updateMask: string, Required. The list of fields to update.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents an OauthClient. Used to access Google Cloud resources on behalf of a Workforce Identity Federation user by using OAuth 2.0 Protocol to obtain an access token from Google Cloud.
"allowedGrantTypes": [ # Required. The list of OAuth grant types is allowed for the OauthClient.
"A String",
],
"allowedRedirectUris": [ # Required. The list of redirect uris that is allowed to redirect back when authorization process is completed.
"A String",
],
"allowedScopes": [ # Required. The list of scopes that the OauthClient is allowed to request during OAuth flows. The following scopes are supported: * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. * `openid`: The OAuth client can associate you with your personal information on Google Cloud. * `email`: The OAuth client can read a federated identity's email address. * `groups`: The OAuth client can read a federated identity's groups.
"A String",
],
"clientId": "A String", # Output only. The system-generated OauthClient id.
"clientType": "A String", # Immutable. The type of OauthClient. Either public or private. For private clients, the client secret can be managed using the dedicated OauthClientCredential resource.
"description": "A String", # Optional. A user-specified description of the OauthClient. Cannot exceed 256 characters.
"disabled": True or False, # Optional. Whether the OauthClient is disabled. You cannot use a disabled OAuth client.
"displayName": "A String", # Optional. A user-specified display name of the OauthClient. Cannot exceed 32 characters.
"expireTime": "A String", # Output only. Time after which the OauthClient will be permanently purged and cannot be recovered.
"name": "A String", # Immutable. Identifier. The resource name of the OauthClient. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.
"state": "A String", # Output only. The state of the OauthClient.
}</pre>
</div>
<div class="method">
<code class="details" id="undelete">undelete(name, body=None, x__xgafv=None)</code>
<pre>Undeletes an OauthClient, as long as it was deleted fewer than 30 days ago.
Args:
name: string, Required. The name of the OauthClient to undelete. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}`. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for UndeleteOauthClient.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents an OauthClient. Used to access Google Cloud resources on behalf of a Workforce Identity Federation user by using OAuth 2.0 Protocol to obtain an access token from Google Cloud.
"allowedGrantTypes": [ # Required. The list of OAuth grant types is allowed for the OauthClient.
"A String",
],
"allowedRedirectUris": [ # Required. The list of redirect uris that is allowed to redirect back when authorization process is completed.
"A String",
],
"allowedScopes": [ # Required. The list of scopes that the OauthClient is allowed to request during OAuth flows. The following scopes are supported: * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. * `openid`: The OAuth client can associate you with your personal information on Google Cloud. * `email`: The OAuth client can read a federated identity's email address. * `groups`: The OAuth client can read a federated identity's groups.
"A String",
],
"clientId": "A String", # Output only. The system-generated OauthClient id.
"clientType": "A String", # Immutable. The type of OauthClient. Either public or private. For private clients, the client secret can be managed using the dedicated OauthClientCredential resource.
"description": "A String", # Optional. A user-specified description of the OauthClient. Cannot exceed 256 characters.
"disabled": True or False, # Optional. Whether the OauthClient is disabled. You cannot use a disabled OAuth client.
"displayName": "A String", # Optional. A user-specified display name of the OauthClient. Cannot exceed 32 characters.
"expireTime": "A String", # Output only. Time after which the OauthClient will be permanently purged and cannot be recovered.
"name": "A String", # Immutable. Identifier. The resource name of the OauthClient. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.
"state": "A String", # Output only. The state of the OauthClient.
}</pre>
</div>
</body></html>
|
