Class WorkforcePool
Represents a collection of external workforces. Provides namespaces for federated users that can be referenced in IAM policies.
Implements
Inherited Members
Namespace: Google.Apis.Iam.v1.Data
Assembly: Google.Apis.Iam.v1.dll
Syntax
public class WorkforcePool : IDirectResponseSchema
Properties
AccessRestrictions
Optional. Configure access restrictions on the workforce pool users. This is an optional field. If specified web sign-in can be restricted to given set of services or programmatic sign-in can be disabled for pool users.
Declaration
[JsonProperty("accessRestrictions")]
public virtual AccessRestrictions AccessRestrictions { get; set; }
Property Value
Type | Description |
---|---|
AccessRestrictions |
Description
Optional. A user-specified description of the pool. Cannot exceed 256 characters.
Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type | Description |
---|---|
string |
Disabled
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.
Declaration
[JsonProperty("disabled")]
public virtual bool? Disabled { get; set; }
Property Value
Type | Description |
---|---|
bool? |
DisplayName
Optional. A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters.
Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
ExpireTime
object representation of ExpireTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ExpireTimeDateTimeOffset instead.")]
public virtual object ExpireTime { get; set; }
Property Value
Type | Description |
---|---|
object |
ExpireTimeDateTimeOffset
DateTimeOffset representation of ExpireTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? ExpireTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
ExpireTimeRaw
Output only. Time after which the workforce pool will be permanently purged and cannot be recovered.
Declaration
[JsonProperty("expireTime")]
public virtual string ExpireTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
Name
Output only. The resource name of the pool. Format:
locations/{location}/workforcePools/{workforce_pool_id}
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
Parent
Immutable. The resource name of the parent. Format: organizations/{org-id}
.
Declaration
[JsonProperty("parent")]
public virtual string Parent { get; set; }
Property Value
Type | Description |
---|---|
string |
SessionDuration
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.
Declaration
[JsonProperty("sessionDuration")]
public virtual object SessionDuration { get; set; }
Property Value
Type | Description |
---|---|
object |
State
Output only. The state of the pool.
Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type | Description |
---|---|
string |