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
|
<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.locations.html">locations</a> . <a href="iam_v1.locations.workforcePools.html">workforcePools</a> . <a href="iam_v1.locations.workforcePools.providers.html">providers</a> . <a href="iam_v1.locations.workforcePools.providers.scimTenants.html">scimTenants</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="iam_v1.locations.workforcePools.providers.scimTenants.tokens.html">tokens()</a></code>
</p>
<p class="firstline">Returns the tokens 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, workforcePoolProviderScimTenantId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Agentspace only. Creates a new WorkforcePoolProviderScimTenant in a WorkforcePoolProvider. You cannot reuse the name of a deleted SCIM tenant until 30 days after deletion.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, hardDelete=None, x__xgafv=None)</a></code></p>
<p class="firstline">Agentspace only. Deletes a WorkforcePoolProviderScimTenant. You can undelete a SCIM tenant for 30 days. After 30 days, deletion is permanent. You cannot update deleted SCIM tenants. 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">Agentspace only. Gets an individual WorkforcePoolProviderScimTenant.</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">Agentspace only. Lists all non-deleted WorkforcePoolProviderScimTenants in a WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted SCIM tenants 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">Agentspace only. Updates an existing WorkforcePoolProviderScimTenant.</p>
<p class="toc_element">
<code><a href="#undelete">undelete(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Agentspace only. Undeletes a WorkforcePoolProviderScimTenant, that 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, workforcePoolProviderScimTenantId=None, x__xgafv=None)</code>
<pre>Agentspace only. Creates a new WorkforcePoolProviderScimTenant in a WorkforcePoolProvider. You cannot reuse the name of a deleted SCIM tenant until 30 days after deletion.
Args:
parent: string, Required. Agentspace only. The parent to create SCIM tenant. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}' (required)
body: object, The request body.
The object takes the form of:
{ # Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.
"baseUri": "A String", # Output only. Agentspace only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/
"claimMapping": { # Optional. Agentspace only. Maps BYOID claims to SCIM claims.
"a_key": "A String",
},
"description": "A String", # Optional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters.
"displayName": "A String", # Optional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters.
"name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
"purgeTime": "A String", # Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged.
"serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent.
"state": "A String", # Output only. Agentspace only. The state of the tenant.
}
workforcePoolProviderScimTenantId: string, Required. Agentspace only. The ID to use for the SCIM tenant, which becomes the final component of the resource name. This value should be 4-32 characters, containing the characters [a-z0-9-].
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.
"baseUri": "A String", # Output only. Agentspace only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/
"claimMapping": { # Optional. Agentspace only. Maps BYOID claims to SCIM claims.
"a_key": "A String",
},
"description": "A String", # Optional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters.
"displayName": "A String", # Optional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters.
"name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
"purgeTime": "A String", # Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged.
"serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent.
"state": "A String", # Output only. Agentspace only. The state of the tenant.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, hardDelete=None, x__xgafv=None)</code>
<pre>Agentspace only. Deletes a WorkforcePoolProviderScimTenant. You can undelete a SCIM tenant for 30 days. After 30 days, deletion is permanent. You cannot update deleted SCIM tenants. However, you can view and list them.
Args:
name: string, Required. Agentspace only. The name of the scim tenant to delete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}` (required)
hardDelete: boolean, Optional. Deletes the SCIM tenant immediately. This operation cannot be undone.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.
"baseUri": "A String", # Output only. Agentspace only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/
"claimMapping": { # Optional. Agentspace only. Maps BYOID claims to SCIM claims.
"a_key": "A String",
},
"description": "A String", # Optional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters.
"displayName": "A String", # Optional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters.
"name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
"purgeTime": "A String", # Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged.
"serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent.
"state": "A String", # Output only. Agentspace only. The state of the tenant.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Agentspace only. Gets an individual WorkforcePoolProviderScimTenant.
Args:
name: string, Required. Agentspace only. The name of the SCIM tenant to retrieve. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.
"baseUri": "A String", # Output only. Agentspace only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/
"claimMapping": { # Optional. Agentspace only. Maps BYOID claims to SCIM claims.
"a_key": "A String",
},
"description": "A String", # Optional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters.
"displayName": "A String", # Optional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters.
"name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
"purgeTime": "A String", # Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged.
"serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent.
"state": "A String", # Output only. Agentspace only. The state of the tenant.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)</code>
<pre>Agentspace only. Lists all non-deleted WorkforcePoolProviderScimTenants in a WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted SCIM tenants are also listed.
Args:
parent: string, Required. Agentspace only. The parent to list SCIM tenants. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}' (required)
pageSize: integer, Optional. Agentspace only. The maximum number of SCIM tenants to return. If unspecified, at most 1 scim tenant will be returned.
pageToken: string, Optional. Agentspace only. A page token, received from a previous `ListScimTenants` call. Provide this to retrieve the subsequent page.
showDeleted: boolean, Optional. Agentspace only. Whether to return soft-deleted SCIM tenants.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Agentspace only. Response message for ListWorkforcePoolProviderScimTenants.
"nextPageToken": "A String", # Optional. Agentspace only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"workforcePoolProviderScimTenants": [ # Output only. Agentspace only. A list of SCIM tenants.
{ # Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.
"baseUri": "A String", # Output only. Agentspace only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/
"claimMapping": { # Optional. Agentspace only. Maps BYOID claims to SCIM claims.
"a_key": "A String",
},
"description": "A String", # Optional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters.
"displayName": "A String", # Optional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters.
"name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
"purgeTime": "A String", # Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged.
"serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent.
"state": "A String", # Output only. Agentspace only. The state of the tenant.
},
],
}</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>Agentspace only. Updates an existing WorkforcePoolProviderScimTenant.
Args:
name: string, Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` (required)
body: object, The request body.
The object takes the form of:
{ # Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.
"baseUri": "A String", # Output only. Agentspace only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/
"claimMapping": { # Optional. Agentspace only. Maps BYOID claims to SCIM claims.
"a_key": "A String",
},
"description": "A String", # Optional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters.
"displayName": "A String", # Optional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters.
"name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
"purgeTime": "A String", # Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged.
"serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent.
"state": "A String", # Output only. Agentspace only. The state of the tenant.
}
updateMask: string, Optional. Agentspace only. 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:
{ # Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.
"baseUri": "A String", # Output only. Agentspace only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/
"claimMapping": { # Optional. Agentspace only. Maps BYOID claims to SCIM claims.
"a_key": "A String",
},
"description": "A String", # Optional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters.
"displayName": "A String", # Optional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters.
"name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
"purgeTime": "A String", # Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged.
"serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent.
"state": "A String", # Output only. Agentspace only. The state of the tenant.
}</pre>
</div>
<div class="method">
<code class="details" id="undelete">undelete(name, body=None, x__xgafv=None)</code>
<pre>Agentspace only. Undeletes a WorkforcePoolProviderScimTenant, that was deleted fewer than 30 days ago.
Args:
name: string, Required. Agentspace only. The name of the SCIM tenant to undelete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}` (required)
body: object, The request body.
The object takes the form of:
{ # Agentspace only. Request message for UndeleteWorkforcePoolProviderScimTenant.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Agentspace only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.
"baseUri": "A String", # Output only. Agentspace only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/
"claimMapping": { # Optional. Agentspace only. Maps BYOID claims to SCIM claims.
"a_key": "A String",
},
"description": "A String", # Optional. Agentspace only. The description of the SCIM tenant. Cannot exceed 256 characters.
"displayName": "A String", # Optional. Agentspace only. The display name of the SCIM tenant. Cannot exceed 32 characters.
"name": "A String", # Identifier. Agentspace only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
"purgeTime": "A String", # Output only. Agentspace only. The timestamp that represents the time when the SCIM tenant is purged.
"serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent.
"state": "A String", # Output only. Agentspace only. The state of the tenant.
}</pre>
</div>
</body></html>
|
