You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/iam_v1.locations.workforcePools.html
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -150,7 +150,7 @@ <h3>Method Details</h3>
150
150
"disabled": True or False, # Optional. Disables the workforce pool. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again.
151
151
"displayName": "A String", # Optional. A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters.
152
152
"expireTime": "A String", # Output only. Time after which the workforce pool will be permanently purged and cannot be recovered.
153
-
"name": "A String", # Output only. The resource name of the pool. Format: `locations/{location}/workforcePools/{workforce_pool_id}`
153
+
"name": "A String", # Identifier. The resource name of the pool. Format: `locations/{location}/workforcePools/{workforce_pool_id}`
154
154
"parent": "A String", # Immutable. The resource name of the parent. Format: `organizations/{org-id}`.
155
155
"sessionDuration": "A String", # Optional. Duration that the Google Cloud access tokens, console sign-in sessions, and `gcloud` sign-in sessions from this pool are valid. Must be greater than 15 minutes (900s) and less than 12 hours (43200s). If `session_duration` is not configured, minted credentials have a default duration of one hour (3600s). For SAML providers, the lifetime of the token is the minimum of the `session_duration` and the `SessionNotOnOrAfter` claim in the SAML assertion.
156
156
"state": "A String", # Output only. The state of the pool.
@@ -248,7 +248,7 @@ <h3>Method Details</h3>
248
248
"disabled": True or False, # Optional. Disables the workforce pool. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again.
249
249
"displayName": "A String", # Optional. A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters.
250
250
"expireTime": "A String", # Output only. Time after which the workforce pool will be permanently purged and cannot be recovered.
251
-
"name": "A String", # Output only. The resource name of the pool. Format: `locations/{location}/workforcePools/{workforce_pool_id}`
251
+
"name": "A String", # Identifier. The resource name of the pool. Format: `locations/{location}/workforcePools/{workforce_pool_id}`
252
252
"parent": "A String", # Immutable. The resource name of the parent. Format: `organizations/{org-id}`.
253
253
"sessionDuration": "A String", # Optional. Duration that the Google Cloud access tokens, console sign-in sessions, and `gcloud` sign-in sessions from this pool are valid. Must be greater than 15 minutes (900s) and less than 12 hours (43200s). If `session_duration` is not configured, minted credentials have a default duration of one hour (3600s). For SAML providers, the lifetime of the token is the minimum of the `session_duration` and the `SessionNotOnOrAfter` claim in the SAML assertion.
254
254
"state": "A String", # Output only. The state of the pool.
@@ -345,7 +345,7 @@ <h3>Method Details</h3>
345
345
"disabled": True or False, # Optional. Disables the workforce pool. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again.
346
346
"displayName": "A String", # Optional. A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters.
347
347
"expireTime": "A String", # Output only. Time after which the workforce pool will be permanently purged and cannot be recovered.
348
-
"name": "A String", # Output only. The resource name of the pool. Format: `locations/{location}/workforcePools/{workforce_pool_id}`
348
+
"name": "A String", # Identifier. The resource name of the pool. Format: `locations/{location}/workforcePools/{workforce_pool_id}`
349
349
"parent": "A String", # Immutable. The resource name of the parent. Format: `organizations/{org-id}`.
350
350
"sessionDuration": "A String", # Optional. Duration that the Google Cloud access tokens, console sign-in sessions, and `gcloud` sign-in sessions from this pool are valid. Must be greater than 15 minutes (900s) and less than 12 hours (43200s). If `session_duration` is not configured, minted credentials have a default duration of one hour (3600s). For SAML providers, the lifetime of the token is the minimum of the `session_duration` and the `SessionNotOnOrAfter` claim in the SAML assertion.
351
351
"state": "A String", # Output only. The state of the pool.
@@ -373,7 +373,7 @@ <h3>Method Details</h3>
373
373
<pre>Updates an existing WorkforcePool.
374
374
375
375
Args:
376
-
name: string, Output only. The resource name of the pool. Format: `locations/{location}/workforcePools/{workforce_pool_id}` (required)
376
+
name: string, Identifier. The resource name of the pool. Format: `locations/{location}/workforcePools/{workforce_pool_id}` (required)
377
377
body: object, The request body.
378
378
The object takes the form of:
379
379
@@ -390,7 +390,7 @@ <h3>Method Details</h3>
390
390
"disabled": True or False, # Optional. Disables the workforce pool. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again.
391
391
"displayName": "A String", # Optional. A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters.
392
392
"expireTime": "A String", # Output only. Time after which the workforce pool will be permanently purged and cannot be recovered.
393
-
"name": "A String", # Output only. The resource name of the pool. Format: `locations/{location}/workforcePools/{workforce_pool_id}`
393
+
"name": "A String", # Identifier. The resource name of the pool. Format: `locations/{location}/workforcePools/{workforce_pool_id}`
394
394
"parent": "A String", # Immutable. The resource name of the parent. Format: `organizations/{org-id}`.
395
395
"sessionDuration": "A String", # Optional. Duration that the Google Cloud access tokens, console sign-in sessions, and `gcloud` sign-in sessions from this pool are valid. Must be greater than 15 minutes (900s) and less than 12 hours (43200s). If `session_duration` is not configured, minted credentials have a default duration of one hour (3600s). For SAML providers, the lifetime of the token is the minimum of the `session_duration` and the `SessionNotOnOrAfter` claim in the SAML assertion.
396
396
"state": "A String", # Output only. The state of the pool.
Copy file name to clipboardExpand all lines: docs/dyn/iam_v1.locations.workforcePools.providers.html
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -146,7 +146,7 @@ <h3>Method Details</h3>
146
146
"filter": "A String", # Optional. The filter used to request specific records from IdP. In case of attributes type as AZURE_AD_GROUPS_MAIL, it represents the filter used to request specific groups for users from IdP. By default, all of the groups associated with the user are fetched. The groups should be mail enabled and security enabled. See https://learn.microsoft.com/en-us/graph/search-query-parameter for more details.
147
147
},
148
148
},
149
-
"name": "A String", # Output only. The resource name of the provider. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}`
149
+
"name": "A String", # Identifier. The resource name of the provider. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}`
150
150
"oidc": { # Represents an OpenId Connect 1.0 identity provider. # An OpenId Connect 1.0 identity provider configuration.
151
151
"clientId": "A String", # Required. The client ID. Must match the audience claim of the JWT issued by the identity provider.
152
152
"clientSecret": { # Representation of a client secret configured for the OIDC provider. # Optional. The optional client secret. Required to enable Authorization Code flow for web sign-in.
@@ -273,7 +273,7 @@ <h3>Method Details</h3>
273
273
"filter": "A String", # Optional. The filter used to request specific records from IdP. In case of attributes type as AZURE_AD_GROUPS_MAIL, it represents the filter used to request specific groups for users from IdP. By default, all of the groups associated with the user are fetched. The groups should be mail enabled and security enabled. See https://learn.microsoft.com/en-us/graph/search-query-parameter for more details.
274
274
},
275
275
},
276
-
"name": "A String", # Output only. The resource name of the provider. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}`
276
+
"name": "A String", # Identifier. The resource name of the provider. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}`
277
277
"oidc": { # Represents an OpenId Connect 1.0 identity provider. # An OpenId Connect 1.0 identity provider configuration.
278
278
"clientId": "A String", # Required. The client ID. Must match the audience claim of the JWT issued by the identity provider.
279
279
"clientSecret": { # Representation of a client secret configured for the OIDC provider. # Optional. The optional client secret. Required to enable Authorization Code flow for web sign-in.
@@ -342,7 +342,7 @@ <h3>Method Details</h3>
342
342
"filter": "A String", # Optional. The filter used to request specific records from IdP. In case of attributes type as AZURE_AD_GROUPS_MAIL, it represents the filter used to request specific groups for users from IdP. By default, all of the groups associated with the user are fetched. The groups should be mail enabled and security enabled. See https://learn.microsoft.com/en-us/graph/search-query-parameter for more details.
343
343
},
344
344
},
345
-
"name": "A String", # Output only. The resource name of the provider. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}`
345
+
"name": "A String", # Identifier. The resource name of the provider. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}`
346
346
"oidc": { # Represents an OpenId Connect 1.0 identity provider. # An OpenId Connect 1.0 identity provider configuration.
347
347
"clientId": "A String", # Required. The client ID. Must match the audience claim of the JWT issued by the identity provider.
348
348
"clientSecret": { # Representation of a client secret configured for the OIDC provider. # Optional. The optional client secret. Required to enable Authorization Code flow for web sign-in.
@@ -389,7 +389,7 @@ <h3>Method Details</h3>
389
389
<pre>Updates an existing WorkforcePoolProvider.
390
390
391
391
Args:
392
-
name: string, Output only. The resource name of the provider. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}` (required)
392
+
name: string, Identifier. The resource name of the provider. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}` (required)
393
393
body: object, The request body.
394
394
The object takes the form of:
395
395
@@ -416,7 +416,7 @@ <h3>Method Details</h3>
416
416
"filter": "A String", # Optional. The filter used to request specific records from IdP. In case of attributes type as AZURE_AD_GROUPS_MAIL, it represents the filter used to request specific groups for users from IdP. By default, all of the groups associated with the user are fetched. The groups should be mail enabled and security enabled. See https://learn.microsoft.com/en-us/graph/search-query-parameter for more details.
417
417
},
418
418
},
419
-
"name": "A String", # Output only. The resource name of the provider. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}`
419
+
"name": "A String", # Identifier. The resource name of the provider. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}`
420
420
"oidc": { # Represents an OpenId Connect 1.0 identity provider. # An OpenId Connect 1.0 identity provider configuration.
421
421
"clientId": "A String", # Required. The client ID. Must match the audience claim of the JWT issued by the identity provider.
422
422
"clientSecret": { # Representation of a client secret configured for the OIDC provider. # Optional. The optional client secret. Required to enable Authorization Code flow for web sign-in.
Copy file name to clipboardExpand all lines: docs/dyn/iam_v1.locations.workforcePools.providers.keys.html
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -124,7 +124,7 @@ <h3>Method Details</h3>
124
124
"notAfterTime": "A String", # Output only. Latest timestamp when this key is valid. Attempts to use this key after this time will fail. Only present if the key data represents a X.509 certificate.
125
125
"notBeforeTime": "A String", # Output only. Earliest timestamp when this key is valid. Attempts to use this key before this time will fail. Only present if the key data represents a X.509 certificate.
126
126
},
127
-
"name": "A String", # Output only. The resource name of the key.
127
+
"name": "A String", # Identifier. The resource name of the key. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}/keys/{key_id}`
128
128
"state": "A String", # Output only. The state of the key.
129
129
"use": "A String", # Required. The purpose of the key.
130
130
}
@@ -217,7 +217,7 @@ <h3>Method Details</h3>
217
217
"notAfterTime": "A String", # Output only. Latest timestamp when this key is valid. Attempts to use this key after this time will fail. Only present if the key data represents a X.509 certificate.
218
218
"notBeforeTime": "A String", # Output only. Earliest timestamp when this key is valid. Attempts to use this key before this time will fail. Only present if the key data represents a X.509 certificate.
219
219
},
220
-
"name": "A String", # Output only. The resource name of the key.
220
+
"name": "A String", # Identifier. The resource name of the key. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}/keys/{key_id}`
221
221
"state": "A String", # Output only. The state of the key.
222
222
"use": "A String", # Required. The purpose of the key.
223
223
}</pre>
@@ -252,7 +252,7 @@ <h3>Method Details</h3>
252
252
"notAfterTime": "A String", # Output only. Latest timestamp when this key is valid. Attempts to use this key after this time will fail. Only present if the key data represents a X.509 certificate.
253
253
"notBeforeTime": "A String", # Output only. Earliest timestamp when this key is valid. Attempts to use this key before this time will fail. Only present if the key data represents a X.509 certificate.
254
254
},
255
-
"name": "A String", # Output only. The resource name of the key.
255
+
"name": "A String", # Identifier. The resource name of the key. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}/keys/{key_id}`
256
256
"state": "A String", # Output only. The state of the key.
257
257
"use": "A String", # Required. The purpose of the key.
"description": "Output only. The resource name of the provider. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}`",
594
+
"description": "Identifier. The resource name of the provider. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}`",
"description": "Output only. The resource name of the pool. Format: `locations/{location}/workforcePools/{workforce_pool_id}`",
5020
-
"readOnly": true,
5019
+
"description": "Identifier. The resource name of the pool. Format: `locations/{location}/workforcePools/{workforce_pool_id}`",
5021
5020
"type": "string"
5022
5021
},
5023
5022
"parent": {
@@ -5085,8 +5084,7 @@ false
5085
5084
"description": "Optional. The configuration for OAuth 2.0 client used to get the additional user attributes. This should be used when users can't get the desired claims in authentication credentials. Currently this configuration is only supported with OIDC protocol."
5086
5085
},
5087
5086
"name": {
5088
-
"description": "Output only. The resource name of the provider. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}`",
5089
-
"readOnly": true,
5087
+
"description": "Identifier. The resource name of the provider. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}`",
5090
5088
"type": "string"
5091
5089
},
5092
5090
"oidc": {
@@ -5130,8 +5128,7 @@ false
5130
5128
"description": "Immutable. Public half of the asymmetric key."
5131
5129
},
5132
5130
"name": {
5133
-
"description": "Output only. The resource name of the key.",
5134
-
"readOnly": true,
5131
+
"description": "Identifier. The resource name of the key. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}/keys/{key_id}`",
0 commit comments