Namespace Google.Apis.Iam.v1.Data
Classes
AccessRestrictions
Access related restrictions on the workforce pool.
AdminAuditData
Audit log information specific to Cloud IAM admin APIs. This message is serialized as an Any
type in the
ServiceData
message of an AuditLog
message.
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.
AuditData
Audit log information specific to Cloud IAM. This message is serialized as an Any
type in the ServiceData
message of an AuditLog
message.
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.
AuditableService
Contains information about an auditable service.
Aws
Represents an Amazon Web Services identity provider.
Binding
Associates members
, or principals, with a role
.
BindingDelta
One delta entry for Binding. Each individual change (only one member in each entry) to a binding will be a separate entry.
CreateRoleRequest
The request to create a new role.
CreateServiceAccountKeyRequest
The service account key create request.
CreateServiceAccountRequest
The service account create request.
DisableServiceAccountKeyRequest
The service account key disable request.
DisableServiceAccountRequest
The service account disable request.
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
EnableServiceAccountKeyRequest
The service account key enable request.
EnableServiceAccountRequest
The service account enable request.
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.
ExtendedStatus
Extended status can store additional metadata. For example, for keys disabled due to their private key data being expoesed we may include a message with more information about the exposure.
GetIamPolicyRequest
Request message for GetIamPolicy
method.
GetPolicyOptions
Encapsulates settings provided to GetIamPolicy.
GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2Client
Represents the OAuth 2.0 client credential configuration for retrieving additional user attributes that are not present in the initial authentication credentials from the identity provider, e.g. groups. See https://datatracker.ietf.org/doc/html/rfc6749#section-4.4 for more details on client credentials grant flow.
GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2ClientQueryParameters
Represents the parameters to control which claims are fetched from an IdP.
GoogleIamAdminV1WorkforcePoolProviderOidc
Represents an OpenId Connect 1.0 identity provider.
GoogleIamAdminV1WorkforcePoolProviderOidcClientSecret
Representation of a client secret configured for the OIDC provider.
GoogleIamAdminV1WorkforcePoolProviderOidcClientSecretValue
Representation of the value of the client secret.
GoogleIamAdminV1WorkforcePoolProviderOidcWebSsoConfig
Configuration for web single sign-on for the OIDC provider.
GoogleIamAdminV1WorkforcePoolProviderSaml
Represents a SAML identity provider.
KeyData
Represents a public key data along with its format.
LintPolicyRequest
The request to lint an IAM policy object.
LintPolicyResponse
The response of a lint operation. An empty response indicates the operation was able to fully execute and no lint issue was found.
LintResult
Structured response of a single validation unit.
ListOauthClientCredentialsResponse
Response message for ListOauthClientCredentials.
ListOauthClientsResponse
Response message for ListOauthClients.
ListRolesResponse
The response containing the roles defined under a resource.
ListServiceAccountKeysResponse
The service account keys list response.
ListServiceAccountsResponse
The service account list response.
ListWorkforcePoolProviderKeysResponse
Response message for ListWorkforcePoolProviderKeys.
ListWorkforcePoolProvidersResponse
Response message for ListWorkforcePoolProviders.
ListWorkforcePoolsResponse
Response message for ListWorkforcePools.
ListWorkloadIdentityPoolProviderKeysResponse
Response message for ListWorkloadIdentityPoolProviderKeys.
ListWorkloadIdentityPoolProvidersResponse
Response message for ListWorkloadIdentityPoolProviders.
ListWorkloadIdentityPoolsResponse
Response message for ListWorkloadIdentityPools.
OauthClient
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.
OauthClientCredential
Represents an OauthClientCredential. Used to authenticate an OauthClient while accessing Google Cloud resources on behalf of a user by using OAuth 2.0 Protocol.
Oidc
Represents an OpenId Connect 1.0 identity provider.
Operation
This resource represents a long-running operation that is the result of a network API call.
OperationMetadata
Represents the metadata of the long-running operation.
PatchServiceAccountRequest
The service account patch request. You can patch only the display_name
and description
fields. You must use
the update_mask
field to specify which of these fields you want to patch. Only the fields specified in the
request are guaranteed to be returned in the response. Other fields may be empty in the response.
Permission
A permission which can be included by a role.
PermissionDelta
A PermissionDelta message to record the added_permissions and removed_permissions inside a role.
Policy
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A
Policy
is a collection of bindings
. A binding
binds one or more members
, or principals, to a single
role
. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A
role
is a named list of permissions; each role
can be an IAM predefined role or a user-created custom role.
For some types of Google Cloud resources, a binding
can also specify a condition
, which is a logical
expression that allows access to a resource only if the expression evaluates to true
. A condition can add
constraints based on attributes of the request, the resource, or both. To learn which resources support
conditions in their IAM policies, see the IAM
documentation. JSON example:
{
"bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com",
"group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] },
{ "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": {
"title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time
< timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }
YAML example:
bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com -
serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin -
members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable
access description: Does not grant access after Sep 2020 expression: request.time <
timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3
For a description of IAM and its features, see the IAM documentation.
PolicyDelta
The difference delta between two policies.
QueryAuditableServicesRequest
A request to get the list of auditable services for a resource.
QueryAuditableServicesResponse
A response containing a list of auditable services for a resource.
QueryGrantableRolesRequest
The grantable role query request.
QueryGrantableRolesResponse
The grantable role query response.
QueryTestablePermissionsRequest
A request to get permissions which can be tested on a resource.
QueryTestablePermissionsResponse
The response containing permissions which can be tested on a resource.
ReconciliationOperationMetadata
Operation metadata returned by the CLH during resource state reconciliation.
Role
A role in the Identity and Access Management API.
Saml
Represents an SAML 2.0 identity provider.
ServiceAccount
An IAM service account. A service account is an account for an application or a virtual machine (VM) instance, not a person. You can use a service account to call Google APIs. To learn more, read the overview of service accounts. When you create a service account, you specify the project ID that owns the service account, as well as a name that must be unique within the project. IAM uses these values to create an email address that identifies the service account. //
ServiceAccountKey
Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API.
ServiceConfig
Configuration for a service.
SetIamPolicyRequest
Request message for SetIamPolicy
method.
SignBlobRequest
Deprecated. Migrate to Service Account Credentials API. The service account sign blob request.
SignBlobResponse
Deprecated. Migrate to Service Account Credentials API. The service account sign blob response.
SignJwtRequest
Deprecated. Migrate to Service Account Credentials API. The service account sign JWT request.
SignJwtResponse
Deprecated. Migrate to Service Account Credentials API. The service account sign JWT response.
Status
The Status
type defines a logical error model that is suitable for different programming environments,
including REST APIs and RPC APIs. It is used by gRPC. Each Status
message contains
three pieces of data: error code, error message, and error details. You can find out more about this error model
and how to work with it in the API Design Guide.
TestIamPermissionsRequest
Request message for TestIamPermissions
method.
TestIamPermissionsResponse
Response message for TestIamPermissions
method.
UndeleteOauthClientRequest
Request message for UndeleteOauthClient.
UndeleteRoleRequest
The request to undelete an existing role.
UndeleteServiceAccountRequest
The service account undelete request.
UndeleteServiceAccountResponse
UndeleteWorkforcePoolProviderKeyRequest
Request message for UndeleteWorkforcePoolProviderKey.
UndeleteWorkforcePoolProviderRequest
Request message for UndeleteWorkforcePoolProvider.
UndeleteWorkforcePoolRequest
Request message for UndeleteWorkforcePool.
UndeleteWorkforcePoolSubjectRequest
Request message for UndeleteWorkforcePoolSubject.
UndeleteWorkloadIdentityPoolProviderKeyRequest
Request message for UndeleteWorkloadIdentityPoolProviderKey.
UndeleteWorkloadIdentityPoolProviderRequest
Request message for UndeleteWorkloadIdentityPoolProvider.
UndeleteWorkloadIdentityPoolRequest
Request message for UndeleteWorkloadIdentityPool.
UploadServiceAccountKeyRequest
The service account key upload request.
WorkforcePool
Represents a collection of external workforces. Provides namespaces for federated users that can be referenced in IAM policies.
WorkforcePoolProvider
A configuration for an external identity provider.
WorkforcePoolProviderKey
Represents a public key configuration for a Workforce Pool Provider. The key can be configured in your identity provider to encrypt SAML assertions. Google holds the corresponding private key, which it uses to decrypt encrypted tokens.
WorkloadIdentityPool
Represents a collection of workload identities. You can define IAM policies to grant these identities access to Google Cloud resources.
WorkloadIdentityPoolOperationMetadata
Metadata for long-running WorkloadIdentityPool operations.
WorkloadIdentityPoolProvider
A configuration for an external identity provider.
WorkloadIdentityPoolProviderKey
Represents a public key configuration for your workload identity pool provider. The key can be configured in your identity provider to encrypt the SAML assertions. Google holds the corresponding private key which it uses to decrypt encrypted tokens.