iam library

Classes

AccessRestrictions
Access related restrictions on the workforce pool.
AccessRestrictionsResponse
Access related restrictions on the workforce pool.
AuditConfig
Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": "user:aliya@example.com" } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
AuditConfigResponse
Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": "user:aliya@example.com" } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
AuditLogConfig
Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
AuditLogConfigResponse
Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
Aws
Represents an Amazon Web Services identity provider.
AwsResponse
Represents an Amazon Web Services identity provider.
Binding
Associates members, or principals, with a role.
BindingResponse
Associates members, or principals, with a role.
Condition
An IAM Condition for a given binding. See https://cloud.google.com/iam/docs/conditions-overview for additional details.
Expr
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
ExprResponse
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
GetKeyArgs
Arguments for getKey. Arguments for getKey.
GetKeyResult
Result data returned by getKey.
GetOrganizationRoleArgs
Arguments for getOrganizationRole. Arguments for getOrganizationRole.
GetOrganizationRoleResult
Result data returned by getOrganizationRole.
GetProviderArgs
Arguments for getProvider. Arguments for getProvider.
GetProviderResult
Result data returned by getProvider.
GetRoleArgs
Arguments for getRole. Arguments for getRole.
GetRoleResult
Result data returned by getRole.
GetServiceAccountArgs
Arguments for getServiceAccount. Arguments for getServiceAccount.
GetServiceAccountIamPolicyArgs
Arguments for getServiceAccountIamPolicy. Arguments for getServiceAccountIamPolicy.
GetServiceAccountIamPolicyResult
Result data returned by getServiceAccountIamPolicy.
GetServiceAccountResult
Result data returned by getServiceAccount.
GetWorkforcePoolArgs
Arguments for getWorkforcePool. Arguments for getWorkforcePool.
GetWorkforcePoolIamPolicyArgs
Arguments for getWorkforcePoolIamPolicy. Arguments for getWorkforcePoolIamPolicy.
GetWorkforcePoolIamPolicyResult
Result data returned by getWorkforcePoolIamPolicy.
GetWorkforcePoolKeyArgs
Arguments for getWorkforcePoolKey. Arguments for getWorkforcePoolKey.
GetWorkforcePoolKeyResult
Result data returned by getWorkforcePoolKey.
GetWorkforcePoolProviderArgs
Arguments for getWorkforcePoolProvider. Arguments for getWorkforcePoolProvider.
GetWorkforcePoolProviderResult
Result data returned by getWorkforcePoolProvider.
GetWorkforcePoolResult
Result data returned by getWorkforcePool.
GetWorkloadIdentityPoolArgs
Arguments for getWorkloadIdentityPool. Arguments for getWorkloadIdentityPool.
GetWorkloadIdentityPoolKeyArgs
Arguments for getWorkloadIdentityPoolKey. Arguments for getWorkloadIdentityPoolKey.
GetWorkloadIdentityPoolKeyResult
Result data returned by getWorkloadIdentityPoolKey.
GetWorkloadIdentityPoolResult
Result data returned by getWorkloadIdentityPool.
GoogleIamAdminV1WorkforcePoolProviderOidc
Represents an OpenId Connect 1.0 identity provider.
GoogleIamAdminV1WorkforcePoolProviderOidcClientSecret
Representation of a client secret configured for the OIDC provider.
GoogleIamAdminV1WorkforcePoolProviderOidcClientSecretResponse
Representation of a client secret configured for the OIDC provider.
GoogleIamAdminV1WorkforcePoolProviderOidcClientSecretValue
Representation of the value of the client secret.
GoogleIamAdminV1WorkforcePoolProviderOidcClientSecretValueResponse
Representation of the value of the client secret.
GoogleIamAdminV1WorkforcePoolProviderOidcResponse
Represents an OpenId Connect 1.0 identity provider.
GoogleIamAdminV1WorkforcePoolProviderOidcWebSsoConfig
Configuration for web single sign-on for the OIDC provider.
GoogleIamAdminV1WorkforcePoolProviderOidcWebSsoConfigResponse
Configuration for web single sign-on for the OIDC provider.
GoogleIamAdminV1WorkforcePoolProviderSaml
Represents a SAML identity provider.
GoogleIamAdminV1WorkforcePoolProviderSamlResponse
Represents a SAML identity provider.
Key
Creates a ServiceAccountKey. Auto-naming is currently not supported for this resource.
KeyArgs
The set of arguments for Key. The set of arguments for Key.
KeyData
Represents a public key data along with its format.
KeyDataResponse
Represents a public key data along with its format.
Oidc
Represents an OpenId Connect 1.0 identity provider.
OidcResponse
Represents an OpenId Connect 1.0 identity provider.
OrganizationRole
Creates a new custom Role.
OrganizationRoleArgs
The set of arguments for OrganizationRole. The set of arguments for OrganizationRole.
Provider
Creates a new WorkloadIdentityPoolProvider in a WorkloadIdentityPool. You cannot reuse the name of a deleted provider until 30 days after deletion. Auto-naming is currently not supported for this resource.
ProviderArgs
The set of arguments for Provider. The set of arguments for Provider.
Role
Creates a new custom Role.
RoleArgs
The set of arguments for Role. The set of arguments for Role.
Saml
Represents an SAML 2.0 identity provider.
SamlResponse
Represents an SAML 2.0 identity provider.
ServiceAccount
Creates a ServiceAccount. Auto-naming is currently not supported for this resource.
ServiceAccountArgs
The set of arguments for ServiceAccount. The set of arguments for ServiceAccount.
ServiceAccountIamBinding
Sets the IAM policy that is attached to a ServiceAccount. Use this method to grant or revoke access to the service account. For example, you could grant a principal the ability to impersonate the service account. This method does not enable the service account to access other resources. To grant roles to a service account on a resource, follow these steps: 1. Call the resource's getIamPolicy method to get its current IAM policy. 2. Edit the policy so that it binds the service account to an IAM role for the resource. 3. Call the resource's setIamPolicy method to update its IAM policy. For detailed instructions, see Manage access to project, folders, and organizations or Manage access to other resources.
ServiceAccountIamBindingArgs
The set of arguments for ServiceAccountIamBinding. The set of arguments for ServiceAccountIamBinding.
ServiceAccountIamMember
Sets the IAM policy that is attached to a ServiceAccount. Use this method to grant or revoke access to the service account. For example, you could grant a principal the ability to impersonate the service account. This method does not enable the service account to access other resources. To grant roles to a service account on a resource, follow these steps: 1. Call the resource's getIamPolicy method to get its current IAM policy. 2. Edit the policy so that it binds the service account to an IAM role for the resource. 3. Call the resource's setIamPolicy method to update its IAM policy. For detailed instructions, see Manage access to project, folders, and organizations or Manage access to other resources.
ServiceAccountIamMemberArgs
The set of arguments for ServiceAccountIamMember. The set of arguments for ServiceAccountIamMember.
ServiceAccountIamPolicy
Sets the IAM policy that is attached to a ServiceAccount. Use this method to grant or revoke access to the service account. For example, you could grant a principal the ability to impersonate the service account. This method does not enable the service account to access other resources. To grant roles to a service account on a resource, follow these steps: 1. Call the resource's getIamPolicy method to get its current IAM policy. 2. Edit the policy so that it binds the service account to an IAM role for the resource. 3. Call the resource's setIamPolicy method to update its IAM policy. For detailed instructions, see Manage access to project, folders, and organizations or Manage access to other resources. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
ServiceAccountIamPolicyArgs
The set of arguments for ServiceAccountIamPolicy. The set of arguments for ServiceAccountIamPolicy.
ServiceConfig
Configuration for a service.
ServiceConfigResponse
Configuration for a service.
WorkforcePool
Creates a new WorkforcePool. You cannot reuse the name of a deleted pool until 30 days after deletion. Auto-naming is currently not supported for this resource.
WorkforcePoolArgs
The set of arguments for WorkforcePool. The set of arguments for WorkforcePool.
WorkforcePoolIamBinding
Sets IAM policies on a WorkforcePool.
WorkforcePoolIamBindingArgs
The set of arguments for WorkforcePoolIamBinding. The set of arguments for WorkforcePoolIamBinding.
WorkforcePoolIamMember
Sets IAM policies on a WorkforcePool.
WorkforcePoolIamMemberArgs
The set of arguments for WorkforcePoolIamMember. The set of arguments for WorkforcePoolIamMember.
WorkforcePoolIamPolicy
Sets IAM policies on a WorkforcePool. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
WorkforcePoolIamPolicyArgs
The set of arguments for WorkforcePoolIamPolicy. The set of arguments for WorkforcePoolIamPolicy.
WorkforcePoolKey
Creates a new WorkforcePoolProviderKey in a WorkforcePoolProvider. Auto-naming is currently not supported for this resource.
WorkforcePoolKeyArgs
The set of arguments for WorkforcePoolKey. The set of arguments for WorkforcePoolKey.
WorkforcePoolProvider
Creates a new WorkforcePoolProvider in a WorkforcePool. You cannot reuse the name of a deleted provider until 30 days after deletion. Auto-naming is currently not supported for this resource.
WorkforcePoolProviderArgs
The set of arguments for WorkforcePoolProvider. The set of arguments for WorkforcePoolProvider.
WorkloadIdentityPool
Creates a new WorkloadIdentityPool. You cannot reuse the name of a deleted pool until 30 days after deletion. Auto-naming is currently not supported for this resource.
WorkloadIdentityPoolArgs
The set of arguments for WorkloadIdentityPool. The set of arguments for WorkloadIdentityPool.
WorkloadIdentityPoolKey
Create a new WorkloadIdentityPoolProviderKey in a WorkloadIdentityPoolProvider. Auto-naming is currently not supported for this resource.
WorkloadIdentityPoolKeyArgs
The set of arguments for WorkloadIdentityPoolKey. The set of arguments for WorkloadIdentityPoolKey.

Enums

AuditLogConfigLogType
The log type that this config enables.
GoogleIamAdminV1WorkforcePoolProviderOidcWebSsoConfigAssertionClaimsBehavior
Required. The behavior for how OIDC Claims are included in the assertion object used for attribute mapping and attribute condition.
GoogleIamAdminV1WorkforcePoolProviderOidcWebSsoConfigResponseType
Required. The Response Type to request for in the OIDC Authorization Request for web sign-in. The CODE Response Type is recommended to avoid the Implicit Flow, for security reasons.
KeyDataKeySpec
Required. The specifications for the key.
KeyKeyAlgorithm
Which type of key and algorithm to use for the key. The default is currently a 2K RSA key. However this may change in the future.
KeyPrivateKeyType
The output format of the private key. The default value is TYPE_GOOGLE_CREDENTIALS_FILE, which is the Google Credentials File format.
OrganizationRoleStage
The current launch stage of the role. If the ALPHA launch stage has been selected for a role, the stage field will not be included in the returned definition for the role.
RoleStage
The current launch stage of the role. If the ALPHA launch stage has been selected for a role, the stage field will not be included in the returned definition for the role.
WorkforcePoolKeyUse
Required. The purpose of the key.
WorkloadIdentityPoolKeyUse
Required. The purpose of the key.

Functions

getKey(GetKeyArgs args, {InvokeOptions? options}) → Future<GetKeyResult>
Gets a ServiceAccountKey. args Arguments passed to this invoke. Arguments for getKey. options Invoke options controlling this call.
getOrganizationRole(GetOrganizationRoleArgs args, {InvokeOptions? options}) → Future<GetOrganizationRoleResult>
Gets the definition of a Role. args Arguments passed to this invoke. Arguments for getOrganizationRole. options Invoke options controlling this call.
getProvider(GetProviderArgs args, {InvokeOptions? options}) → Future<GetProviderResult>
Gets an individual WorkloadIdentityPoolProvider. args Arguments passed to this invoke. Arguments for getProvider. options Invoke options controlling this call.
getRole(GetRoleArgs args, {InvokeOptions? options}) → Future<GetRoleResult>
Gets the definition of a Role. args Arguments passed to this invoke. Arguments for getRole. options Invoke options controlling this call.
getServiceAccount(GetServiceAccountArgs args, {InvokeOptions? options}) → Future<GetServiceAccountResult>
Gets a ServiceAccount. args Arguments passed to this invoke. Arguments for getServiceAccount. options Invoke options controlling this call.
getServiceAccountIamPolicy(GetServiceAccountIamPolicyArgs args, {InvokeOptions? options}) → Future<GetServiceAccountIamPolicyResult>
Gets the IAM policy that is attached to a ServiceAccount. This IAM policy specifies which principals have access to the service account. This method does not tell you whether the service account has been granted any roles on other resources. To check whether a service account has role grants on a resource, use the getIamPolicy method for that resource. For example, to view the role grants for a project, call the Resource Manager API's projects.getIamPolicy method. args Arguments passed to this invoke. Arguments for getServiceAccountIamPolicy. options Invoke options controlling this call.
getWorkforcePool(GetWorkforcePoolArgs args, {InvokeOptions? options}) → Future<GetWorkforcePoolResult>
Gets an individual WorkforcePool. args Arguments passed to this invoke. Arguments for getWorkforcePool. options Invoke options controlling this call.
getWorkforcePoolIamPolicy(GetWorkforcePoolIamPolicyArgs args, {InvokeOptions? options}) → Future<GetWorkforcePoolIamPolicyResult>
Gets IAM policies on a WorkforcePool. args Arguments passed to this invoke. Arguments for getWorkforcePoolIamPolicy. options Invoke options controlling this call.
getWorkforcePoolKey(GetWorkforcePoolKeyArgs args, {InvokeOptions? options}) → Future<GetWorkforcePoolKeyResult>
Gets a WorkforcePoolProviderKey. args Arguments passed to this invoke. Arguments for getWorkforcePoolKey. options Invoke options controlling this call.
getWorkforcePoolProvider(GetWorkforcePoolProviderArgs args, {InvokeOptions? options}) → Future<GetWorkforcePoolProviderResult>
Gets an individual WorkforcePoolProvider. args Arguments passed to this invoke. Arguments for getWorkforcePoolProvider. options Invoke options controlling this call.
getWorkloadIdentityPool(GetWorkloadIdentityPoolArgs args, {InvokeOptions? options}) → Future<GetWorkloadIdentityPoolResult>
Gets an individual WorkloadIdentityPool. args Arguments passed to this invoke. Arguments for getWorkloadIdentityPool. options Invoke options controlling this call.
getWorkloadIdentityPoolKey(GetWorkloadIdentityPoolKeyArgs args, {InvokeOptions? options}) → Future<GetWorkloadIdentityPoolKeyResult>
Gets an individual WorkloadIdentityPoolProviderKey. args Arguments passed to this invoke. Arguments for getWorkloadIdentityPoolKey. options Invoke options controlling this call.