E 1 S r SSKJr SSKJr SSKJr SSKJr Sr " S S\R 5 r " S S
\R 5 r " S S \R 5 r
" S
S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S \R 5 r " S S \R 5 r " S S \R 5 r " S! S"\R 5 r " S# S$\R 5 r " S% S&\R 5 r " S' S(\R 5 r " S) S*\R 5 r " S+ S,\R 5 r " S- S.\R 5 r " S/ S0\R 5 r " S1 S2\R 5 r " S3 S4\R 5 r! " S5 S6\R 5 r" " S7 S8\R 5 r# " S9 S:\R 5 r$ " S; S<\R 5 r% " S= S>\R 5 r& " S? S@\R 5 r' " SA SB\R 5 r( " SC SD\R 5 r) " SE SF\R 5 r* " SG SH\R 5 r+ " SI SJ\R 5 r, " SK SL\R 5 r- " SM SN\R 5 r. " SO SP\R 5 r/ " SQ SR\R 5 r0 " SS ST\R 5 r1 " SU SV\R 5 r2 " SW SX\R 5 r3 " SY SZ\R 5 r4 " S[ S\\R 5 r5 " S] S^\R 5 r6 " S_ S`\R 5 r7 " Sa Sb\R 5 r8 " Sc Sd\R 5 r9 " Se Sf\R 5 r: " Sg Sh\R 5 r; " Si Sj\R 5 r< " Sk Sl\R 5 r= " Sm Sn\R 5 r> " So Sp\R 5 r? " Sq Sr\R 5 r@ " Ss St\R 5 rA " Su Sv\R 5 rB " Sw Sx\R 5 rC " Sy Sz\R 5 rD " S{ S|\R 5 rE " S} S~\R 5 rF " S S\R 5 rG " S S\R 5 rH " S S\R 5 rI " S S\R 5 rJ " S S\R 5 rK " S S\R 5 rL " S S\R 5 rM " S S\R 5 rN " S S\R 5 rO " S S\R 5 rP " S S\R 5 rQ " S S\R 5 rR " S S\R 5 rS " S S\R 5 rT " S S\R 5 rU " S S\R 5 rV " S S\R 5 rW " S S\R 5 rX " S S\R 5 rY " S S\R 5 rZ " S S\R 5 r[ " S S\R 5 r\ " S S\R 5 r] " S S\R 5 r^ " S S\R 5 r_ " S S\R 5 r` " S S\R 5 ra " S S\R 5 rb " S S\R 5 rc " S S\R 5 rd " S S\R 5 re " S S\R 5 rf " S S\R 5 rg " S S\R 5 rh " S S\R 5 ri " S S\R 5 rj " S S\R 5 rk " S S\R 5 rl " S S\R 5 rm " S S\R 5 rn " S S\R 5 ro " S S\R 5 rp " S S\R 5 rq " S S\R 5 rr " S S\R 5 rs " S S\R 5 rt " S S\R 5 ru " S S\R 5 rv " S S\R 5 rw " S S\R 5 rx " S S\R 5 ry " S S\R 5 rz " S S\R 5 r{ " S S\R 5 r| " S S\R 5 r} " S S\R 5 r~ " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S GS \R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS
\R 5 r " GS GS \R 5 r " GS
GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS \R 5 r " GS GS \R 5 r " GS GS \R 5 r " GS! GS"\R 5 r " GS# GS$\R 5 r " GS% GS&\R 5 r " GS' GS(\R 5 r " GS) GS*\R 5 r " GS+ GS,\R 5 r " GS- GS.\R 5 r " GS/ GS0\R 5 r " GS1 GS2\R 5 r " GS3 GS4\R 5 r " GS5 GS6\R 5 r " GS7 GS8\R 5 r " GS9 GS:\R 5 r " GS; GS<\R 5 r " GS= GS>\R 5 r " GS? GS@\R 5 r " GSA GSB\R 5 r " GSC GSD\R 5 r " GSE GSF\R 5 r " GSG GSH\R 5 r " GSI GSJ\R 5 r " GSK GSL\R 5 r " GSM GSN\R 5 r " GSO GSP\R 5 r " GSQ GSR\R 5 r " GSS GST\R 5 r " GSU GSV\R 5 r " GSW GSX\R 5 r " GSY GSZ\R 5 r " GS[ GS\\R 5 r " GS] GS^\R 5 r " GS_ GS`\R 5 r " GSa GSb\R 5 r " GSc GSd\R 5 r " GSe GSf\R 5 r " GSg GSh\R 5 r " GSi GSj\R 5 r " GSk GSl\R 5 r " GSm GSn\R 5 r " GSo GSp\R 5 r " GSq GSr\R 5 r " GSs GSt\R 5 r " GSu GSv\R 5 r " GSw GSx\R 5 r " GSy GSz\R 5 r " GS{ GS|\R 5 r " GS} GS~\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 Gr " GS GS\R 5 Gr " GS GS\R 5 Gr " GS GS\R 5 Gr " GS GS\R 5 Gr " GS GS\R 5 Gr " GS GS\R 5 Gr " GS GS \R 5 Gr " GS GS\R 5 Gr " GS GS\R 5 Gr " GS GS\R 5 Gr
" GS GS\R 5 Gr " GS GS
\R 5 Gr " GS GS \R 5 Gr
" GS
GS\R 5 Gr " GS GS\R 5 Gr " GS GS\R 5 Gr " GS GS\R 5 Gr " GS GS\R 5 Gr " GS GS\R 5 Gr " GS GS\R 5 Gr " GS GS \R 5 Gr " GS GS \R 5 Gr " GS GS \R 5 Gr " GS! GS"\R 5 Gr " GS# GS$\R 5 Gr " GS% GS&\R 5 Gr " GS' GS(\R 5 Gr " GS) GS*\R 5 Gr " GS+ GS,\R 5 Gr " GS- GS.\R 5 Gr " GS/ GS0\R 5 Gr " GS1 GS2\R 5 Gr " GS3 GS4\R 5 Gr! " GS5 GS6\R 5 Gr" " GS7 GS8\R 5 Gr#\GRH " \GS9GS:5 \GRJ " \GRL GS;GS<5 \GRJ " \GRL GS=GS>5 \GRH " \GS?GS@5 GgA(B a Generated message classes for iam version v1.
Manages identity and access control for Google Cloud resources, including the
creation of service accounts, which you can use to authenticate to Google and
make API calls. Enabling this API also enables the IAM Service Account
Credentials API (iamcredentials.googleapis.com). However, disabling this API
doesn't disable the IAM Service Account Credentials API.
)absolute_import)messages)encoding) extra_typesiamc ` \ rS rSrSr\R " SSSS9r\R " S5 r Sr
g )
AccessRestrictions a Access related restrictions on the workforce pool.
Fields:
allowedServices: Optional. Immutable. Services allowed for web sign-in
with the workforce pool. If not set by default there are no
restrictions.
disableProgrammaticSignin: Optional. Disable programmatic sign-in by
disabling token issue via the Security Token API endpoint. See [Security
Token Service API]
(https://cloud.google.com/iam/docs/reference/sts/rest).
ServiceConfig Trepeated N) __name__
__module__ __qualname____firstlineno____doc__ _messages MessageFieldallowedServices BooleanFielddisableProgrammaticSignin__static_attributes__r Clib/googlecloudsdk/generated_clients/apis/iam/v1/iam_v1_messages.pyr r s.
**?AM/ ' 4 4Q 7r r c > \ rS rSrSr\R " SS5 rSrg)AddAttestationRuleRequest& zpRequest message for AddAttestationRule.
Fields:
attestationRule: Required. The attestation rule to be added.
AttestationRuler r N r r r r r r r attestationRuler r r r r r & **+ \ rS rSrSr\R " SS5 rSrg)AdminAuditData0 zAudit log information specific to Cloud IAM admin APIs. This message is
serialized as an `Any` type in the `ServiceData` message of an `AuditLog`
message.
Fields:
permissionDelta: The permission_delta when when creating or updating a
Role.
PermissionDeltar r N) r r r r r r r permissionDeltar r r r r& r& 0 s **+ \ rS rSrSr\R " SS5 rSrg) AuditData zAudit log information specific to Cloud IAM. This message is serialized
as an `Any` type in the `ServiceData` message of an `AuditLog` message.
Fields:
policyDelta: Policy delta between the original policy and the newly set
policy.
PolicyDeltar r N) r r r r r r r policyDeltar r r r rH rH s &&}a8+r rH c \ rS rSrSr " S S\R 5 r\R " SSS9r \R " SS5 r S r g
) rD aR 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.
Enums:
LogTypeValueValuesEnum: The log type that this config enables.
Fields:
exemptedMembers: Specifies the identities that do not cause logging for
this type of permission. Follows the same format of Binding.members.
logType: The log type that this config enables.
c ( \ rS rSrSrSrSrSrSrSr g) %AuditLogConfig.LogTypeValueValuesEnum a The log type that this config enables.
Values:
LOG_TYPE_UNSPECIFIED: Default case. Should never be this.
ADMIN_READ: Admin reads. Example: CloudIAM getIamPolicy
DATA_WRITE: Data writes. Example: CloudSQL Users create
DATA_READ: Data reads. Example: CloudSQL Users list
r r r r5 r N)
r r r r r LOG_TYPE_UNSPECIFIED
ADMIN_READ
DATA_WRITE DATA_READr r r r LogTypeValueValuesEnumrO s JJIr rU r Tr
r r N)
r r r r r r r7 rU r9 exemptedMembersr; logTyper r r r rD rD s>
y~~ ))!d;/ 8! <'r rD c < \ rS rSrSr\R " S5 rSrg)AuditableService zContains information about an auditable service.
Fields:
name: Public name of the service. For example, the service name for IAM is
'iam.googleapis.com'.
r r N r r r r r r r9 r: r r r r rY rY s
q !$r rY c < \ rS rSrSr\R " S5 rSrg)Aws ziRepresents an Amazon Web Services identity provider.
Fields:
accountId: Required. The AWS account ID.
r r N) r r r r r r r9 accountIdr r r r r] r] s ##A&)r r] c \ rS rSrSr\R " SS5 r\R " SSS9r \R " S5 r
S r g
) Binding at Associates `members`, or principals, with a `role`.
Fields:
condition: The condition that is associated with this binding. If the
condition evaluates to `true`, then this binding applies to the current
request. If the condition evaluates to `false`, then this binding does
not apply to the current request. However, a different role binding
might grant the same role to one or more of the principals in this
binding. To learn which resources support conditions in their IAM
policies, see the [IAM
documentation](https://cloud.google.com/iam/help/conditions/resource-
policies).
members: Specifies the principals requesting access for a Google Cloud
resource. `members` can have the following values: * `allUsers`: A
special identifier that represents anyone who is on the internet; with
or without a Google account. * `allAuthenticatedUsers`: A special
identifier that represents anyone who is authenticated with a Google
account or a service account. Does not include identities that come from
external identity providers (IdPs) through identity federation. *
`user:{emailid}`: An email address that represents a specific Google
account. For example, `alice@example.com` . *
`serviceAccount:{emailid}`: An email address that represents a Google
service account. For example, `my-other-
app@appspot.gserviceaccount.com`. *
`serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`:
An identifier for a [Kubernetes service
account](https://cloud.google.com/kubernetes-engine/docs/how-
to/kubernetes-service-accounts). For example, `my-
project.svc.id.goog[my-namespace/my-kubernetes-sa]`. *
`group:{emailid}`: An email address that represents a Google group. For
example, `admins@example.com`. * `domain:{domain}`: The G Suite domain
(primary) that represents all the users of that domain. For example,
`google.com` or `example.com`. * `principal://iam.googleapis.com/locatio
ns/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A
single identity in a workforce identity pool. * `principalSet://iam.goog
leapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
All workforce identities in a group. * `principalSet://iam.googleapis.co
m/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{
attribute_value}`: All workforce identities with a specific attribute
value. * `principalSet://iam.googleapis.com/locations/global/workforcePo
ols/{pool_id}/*`: All identities in a workforce identity pool. * `princi
pal://iam.googleapis.com/projects/{project_number}/locations/global/work
loadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single
identity in a workload identity pool. * `principalSet://iam.googleapis.c
om/projects/{project_number}/locations/global/workloadIdentityPools/{poo
l_id}/group/{group_id}`: A workload identity pool group. * `principalSet
://iam.googleapis.com/projects/{project_number}/locations/global/workloa
dIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
All identities in a workload identity pool with a certain attribute. * `
principalSet://iam.googleapis.com/projects/{project_number}/locations/gl
obal/workloadIdentityPools/{pool_id}/*`: All identities in a workload
identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email
address (plus unique identifier) representing a user that has been
recently deleted. For example,
`alice@example.com?uid=123456789012345678901`. If the user is recovered,
this value reverts to `user:{emailid}` and the recovered user retains
the role in the binding. *
`deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address
(plus unique identifier) representing a service account that has been
recently deleted. For example, `my-other-
app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the
service account is undeleted, this value reverts to
`serviceAccount:{emailid}` and the undeleted service account retains the
role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An
email address (plus unique identifier) representing a Google group that
has been recently deleted. For example,
`admins@example.com?uid=123456789012345678901`. If the group is
recovered, this value reverts to `group:{emailid}` and the recovered
group retains the role in the binding. * `deleted:principal://iam.google
apis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attr
ibute_value}`: Deleted single identity in a workforce identity pool. For
example, `deleted:principal://iam.googleapis.com/locations/global/workfo
rcePools/my-pool-id/subject/my-subject-attribute-value`.
role: Role that is assigned to the list of `members`, or principals. For
example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an
overview of the IAM roles and permissions, see the [IAM
documentation](https://cloud.google.com/iam/docs/roles-overview). For a
list of the available pre-defined roles, see
[here](https://cloud.google.com/iam/docs/understanding-roles).
Exprr r Tr
r5 r N) r r r r r r r conditionr9 membersroler r r r ra ra s? Ob $$VQ/) ! !!d 3' q !$r ra c \ rS rSrSr " S S\R 5 r\R " SS5 r \R " SS5 r \R " S5 r
\R " S 5 rS
rg ) BindingDeltai$ aZ One delta entry for Binding. Each individual change (only one member in
each entry) to a binding will be a separate entry.
Enums:
ActionValueValuesEnum: The action that was performed on a Binding.
Required
Fields:
action: The action that was performed on a Binding. Required
condition: The condition that is associated with this binding.
member: A single identity requesting access for a Google Cloud resource.
Follows the same format of Binding.members. Required
role: Role that is assigned to `members`. For example, `roles/viewer`,
`roles/editor`, or `roles/owner`. Required
c $ \ rS rSrSrSrSrSrSrg)"BindingDelta.ActionValueValuesEnumi5 zThe action that was performed on a Binding. Required
Values:
ACTION_UNSPECIFIED: Unspecified.
ADD: Addition of a Binding.
REMOVE: Removal of a Binding.
r r r r N) r r r r r ACTION_UNSPECIFIEDADDREMOVEr r r r ActionValueValuesEnumrj 5 s
C
Fr rn r rc r r5 r6 r N)r r r r r r r7 rn r; actionr rd r9 memberrf r r r r rh rh $ s^
inn
6 :&$$VQ/) #& q !$r rh c b \ rS rSrSr\R " SS5 r\R " S5 r Sr
g)CreateRoleRequestiG a# The request to create a new role.
Fields:
role: The Role resource to create.
roleId: The role ID to use for this role. A role ID may contain
alphanumeric characters, underscores (`_`), and periods (`.`). It must
contain a minimum of 3 characters and a maximum of 64 characters.
Roler r r N) r r r r r r r rf r9 roleIdr r r r rr rr G s+
*$ #&r rr c \ rS rSrSr " S S\R 5 r " S S\R 5 r\R " SS5 r
\R " SS5 r S r g
) CreateServiceAccountKeyRequestiU a The service account key create request.
Enums:
KeyAlgorithmValueValuesEnum: 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.
PrivateKeyTypeValueValuesEnum: The output format of the private key. The
default value is `TYPE_GOOGLE_CREDENTIALS_FILE`, which is the Google
Credentials File format.
Fields:
keyAlgorithm: 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.
privateKeyType: The output format of the private key. The default value is
`TYPE_GOOGLE_CREDENTIALS_FILE`, which is the Google Credentials File
format.
c $ \ rS rSrSrSrSrSrSrg):CreateServiceAccountKeyRequest.KeyAlgorithmValueValuesEnumii a 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.
Values:
KEY_ALG_UNSPECIFIED: An unspecified key algorithm.
KEY_ALG_RSA_1024: 1k RSA Key.
KEY_ALG_RSA_2048: 2k RSA Key.
r r r r N r r r r r KEY_ALG_UNSPECIFIEDKEY_ALG_RSA_1024KEY_ALG_RSA_2048r r r r KeyAlgorithmValueValuesEnumrx i s r r} c $ \ rS rSrSrSrSrSrSrg).r r c \ rS rSrSr " S S\R 5 r\R " S5 r \R " SS5 r Sr g) DisableServiceAccountKeyRequesti a The service account key disable request.
Enums:
ServiceAccountKeyDisableReasonValueValuesEnum: Optional. Describes the
reason this key is being disabled. If unspecified, the default value of
SERVICE_ACCOUNT_KEY_DISABLE_REASON_USER_INITIATED will be used.
Fields:
extendedStatusMessage: Optional. Usable by internal google services only.
An extended_status_message can be used to include additional information
about the key, such as its private key data being exposed on a public
repository like GitHub.
serviceAccountKeyDisableReason: Optional. Describes the reason this key is
being disabled. If unspecified, the default value of
SERVICE_ACCOUNT_KEY_DISABLE_REASON_USER_INITIATED will be used.
c ( \ rS rSrSrSrSrSrSrSr g) MDisableServiceAccountKeyRequest.ServiceAccountKeyDisableReasonValueValuesEnumi a Optional. Describes the reason this key is being disabled. If
unspecified, the default value of
SERVICE_ACCOUNT_KEY_DISABLE_REASON_USER_INITIATED will be used.
Values:
SERVICE_ACCOUNT_KEY_DISABLE_REASON_UNSPECIFIED: Unspecified disable
reason
SERVICE_ACCOUNT_KEY_DISABLE_REASON_USER_INITIATED: Disabled by the user
SERVICE_ACCOUNT_KEY_DISABLE_REASON_EXPOSED: Google detected this Service
Account external key's private key data as exposed, typically in a
public repository on GitHub or similar.
SERVICE_ACCOUNT_KEY_DISABLE_REASON_COMPROMISE_DETECTED: This service
account external key was detected as compromised and used by an
attacker.
r r r r5 r N
r r r r r .SERVICE_ACCOUNT_KEY_DISABLE_REASON_UNSPECIFIED1SERVICE_ACCOUNT_KEY_DISABLE_REASON_USER_INITIATED*SERVICE_ACCOUNT_KEY_DISABLE_REASON_EXPOSED6SERVICE_ACCOUNT_KEY_DISABLE_REASON_COMPROMISE_DETECTEDr r r r -ServiceAccountKeyDisableReasonValueValuesEnumr s! 67289512.=>:r r r r r N)
r r r r r r r7 r r9 extendedStatusMessager; serviceAccountKeyDisableReasonr r r r r r s? "?inn ?* $//2#,#6#67fhi#j r r c \ rS rSrSrSrg) DisableServiceAccountRequesti z$The service account disable request.r Nr r r r r r r r r r r s -r r c \ rS rSrSrSrg)Emptyi a 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); }
r Nr r r r r r s r r c \ rS rSrSrSrg) EnableServiceAccountKeyRequesti z'The service account key enable request.r Nr r r r r r s 0r r c \ rS rSrSrSrg)EnableServiceAccountRequesti z#The service account enable request.r Nr r r r r r s ,r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r \R " S5 r
Sr g) rc i aq 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.
Fields:
description: Optional. Description of the expression. This is a longer
text which describes the expression, e.g. when hovered over it in a UI.
expression: Textual representation of an expression in Common Expression
Language syntax.
location: Optional. String indicating the location of the expression for
error reporting, e.g. a file name and a position in the file.
title: Optional. Title for the expression, i.e. a short string describing
its purpose. This can be used e.g. in UIs which allow to enter the
expression.
r r r5 r6 r N) r r r r r r r9 description
expressionlocationtitler r r r rc rc sI : %%a(+$$Q'*
"
"1
%(
"%r rc c \ rS rSrSr " S S\R 5 r\R " SS5 r \R " S5 r Sr g) ExtendedStatusi a\ 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.
Enums:
KeyValueValuesEnum: The key for this extended status.
Fields:
key: The key for this extended status.
value: The value for the extended status.
c $ \ rS rSrSrSrSrSrSrg)!ExtendedStatus.KeyValueValuesEnumi a/ The key for this extended status.
Values:
SERVICE_ACCOUNT_KEY_EXTENDED_STATUS_KEY_UNSPECIFIED: Unspecified
extended status, should not be used.
SERVICE_ACCOUNT_KEY_EXTENDED_STATUS_KEY_EXPOSED: This key has been
detected as exposed. extended_status_value may contain information
about the exposure (public GitHub repo, open internet, etc.)
SERVICE_ACCOUNT_KEY_EXTENDED_STATUS_KEY_COMPROMISE_DETECTED: This key
was implicated in a compromise or other attack. extended_status_value
may contain information about the abuse perpetrated.
r r r r N) r r r r r 3SERVICE_ACCOUNT_KEY_EXTENDED_STATUS_KEY_UNSPECIFIED/SERVICE_ACCOUNT_KEY_EXTENDED_STATUS_KEY_EXPOSED;SERVICE_ACCOUNT_KEY_EXTENDED_STATUS_KEY_COMPROMISE_DETECTEDr r r r KeyValueValuesEnumr s ;<7673BC?r r r r r N)
r r r r r r r7 r r; keyr9 valuer r r r r r s>
D9>> D" 0!4#
"%r r c > \ rS rSrSr\R " SS5 rSrg)GetIamPolicyRequesti! zRequest message for `GetIamPolicy` method.
Fields:
options: OPTIONAL: A `GetPolicyOptions` object for specifying options to
`GetIamPolicy`.
GetPolicyOptionsr r N) r r r r r r r optionsr r r r r r ! s
" "#5q 9'r r c b \ rS rSrSr\R " S\R R S9r Sr
g)r i, a] Encapsulates settings provided to GetIamPolicy.
Fields:
requestedPolicyVersion: Optional. The maximum policy version that will be
used to format the policy. Valid values are 0, 1, and 3. Requests
specifying an invalid value will be rejected. Requests for policies with
any conditional role bindings must specify version 3. Policies with no
conditional role bindings may specify any valid value or leave the field
unset. The policy in the response might use the policy version that you
specified, or it might use a lower policy version. For example, if you
specify version 3, but the policy has no conditional role bindings, the
response uses version 1. To learn which resources support conditions in
their IAM policies, see the [IAM
documentation](https://cloud.google.com/iam/help/conditions/resource-
policies).
r variantr N) r r r r r r IntegerFieldVariantINT32requestedPolicyVersionr r r r r r , s( " %11!Y=N=N=T=TUr r c \ rS rSrSr " S S\R 5 r\R " SS5 r \R " S5 r \R " SS5 r
\R " S 5 r\R " S
S 5 rS rg
)@GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2ClientiA a 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.
Enums:
AttributesTypeValueValuesEnum: Required. Represents the IdP and type of
claims that should be fetched.
Fields:
attributesType: Required. Represents the IdP and type of claims that
should be fetched.
clientId: Required. The OAuth 2.0 client ID for retrieving extra
attributes from the identity provider. Required to get the Access Token
using client credentials grant flow.
clientSecret: Required. The OAuth 2.0 client secret for retrieving extra
attributes from the identity provider. Required to get the Access Token
using client credentials grant flow.
issuerUri: Required. The OIDC identity provider's issuer URI. Must be a
valid URI using the `https` scheme. Required to get the OIDC discovery
document.
queryParameters: Optional. Represents the parameters to control which
claims are fetched from an IdP.
c ( \ rS rSrSrSrSrSrSrSr g) ^GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2Client.AttributesTypeValueValuesEnumi\ a Required. Represents the IdP and type of claims that should be
fetched.
Values:
ATTRIBUTES_TYPE_UNSPECIFIED: No AttributesType specified.
AZURE_AD_GROUPS_MAIL: Used to get the user's group claims from the
Microsoft Entra ID identity provider using the configuration provided
in ExtraAttributesOAuth2Client. The `mail` property of the
`microsoft.graph.group` object is used for claim mapping. See
https://learn.microsoft.com/en-
us/graph/api/resources/group?view=graph-rest-1.0#properties for more
details on `microsoft.graph.group` properties. The group mail
addresses of the user's groups that are returned from Microsoft Entra
ID can be mapped by using the following attributes: * OIDC:
`assertion.groups` * SAML: `assertion.attributes.groups`
AZURE_AD_GROUPS_ID: Used to get the user's group claims from the
Microsoft Entra ID identity provider using the configuration provided
in ExtraAttributesOAuth2Client. The `id` property of the
`microsoft.graph.group` object is used for claim mapping. See
https://learn.microsoft.com/en-
us/graph/api/resources/group?view=graph-rest-1.0#properties for more
details on `microsoft.graph.group` properties. The group IDs of the
user's groups that are returned from Microsoft Entra ID can be mapped
by using the following attributes: * OIDC: `assertion.groups` * SAML:
`assertion.attributes.groups`
AZURE_AD_GROUPS_DISPLAY_NAME: Used to get the user's group claims from
the Microsoft Entra ID identity provider using the configuration
provided in ExtraAttributesOAuth2Client. The `displayName` property of
the `microsoft.graph.group` object is used for claim mapping. See
https://learn.microsoft.com/en-
us/graph/api/resources/group?view=graph-rest-1.0#properties for more
details on `microsoft.graph.group` properties. The display names of
the user's groups that are returned from Microsoft Entra ID can be
mapped by using the following attributes: * OIDC: `assertion.groups` *
SAML: `assertion.attributes.groups`
r r r r5 r N)
r r r r r ATTRIBUTES_TYPE_UNSPECIFIEDAZURE_AD_GROUPS_MAILAZURE_AD_GROUPS_ID AZURE_AD_GROUPS_DISPLAY_NAMEr r r r AttributesTypeValueValuesEnumr \ s" #H #$ #$ r r r r 5GoogleIamAdminV1WorkforcePoolProviderOidcClientSecretr5 r6 OGoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2ClientQueryParameters r N)r r r r r r r7 r r; attributesTyper9 clientIdr clientSecret issuerUriqueryParametersr r r r r r A sx 4(%inn (%T &&'FJ.
"
"1
%(''(_abc,##A&) **+|~ A/r r c < \ rS rSrSr\R " S5 rSrg)r i a Represents the parameters to control which claims are fetched from an
IdP.
Fields:
filter: Optional. The filter used to request specific records from the
IdP. By default, all of the groups that are associated with a user are
fetched. For Microsoft Entra ID, you can add `$search` query parameters
using [Keyword Query Language] (https://learn.microsoft.com/en-
us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-
reference). To learn more about `$search` querying in Microsoft Entra
ID, see [Use the `$search` query parameter]
(https://learn.microsoft.com/en-us/graph/search-query-parameter).
Additionally, Workforce Identity Federation automatically adds the
following [`$filter` query parameters] (https://learn.microsoft.com/en-
us/graph/filter-query-parameter), based on the value of
`attributes_type`. Values passed to `filter` are converted to `$search`
query parameters. Additional `$filter` query parameters cannot be added
using this field. * `AZURE_AD_GROUPS_MAIL`: `mailEnabled` and
`securityEnabled` filters are applied. * `AZURE_AD_GROUPS_ID`:
`securityEnabled` filter is applied.
r r N) r r r r r r r9 filterr r r r r r s , #&r r c \ rS rSrSr\R " S5 r\R " SS5 r \R " S5 r
\R " S5 r \R " SS 5 r S
r
g ) )GoogleIamAdminV1WorkforcePoolProviderOidci aL Represents an OpenId Connect 1.0 identity provider.
Fields:
clientId: Required. The client ID. Must match the audience claim of the
JWT issued by the identity provider.
clientSecret: Optional. The optional client secret. Required to enable
Authorization Code flow for web sign-in.
issuerUri: Required. The OIDC issuer URI. Must be a valid URI using the
`https` scheme.
jwksJson: Optional. OIDC JWKs in JSON String format. For details on the
definition of a JWK, see https://tools.ietf.org/html/rfc7517. If not
set, the `jwks_uri` from the discovery document(fetched from the .well-
known path of the `issuer_uri`) will be used. Currently, RSA and EC
asymmetric keys are supported. The JWK must use following format and
include only the following fields: { "keys": [ { "kty": "RSA/EC", "alg":
"", "use": "sig", "kid": "", "n": "", "e": "", "x": "", "y": "", "crv":
"" } ] }
webSsoConfig: Required. Configuration for web single sign-on for the OIDC
provider. Here, web sign-in refers to console sign-in and gcloud sign-in
through the browser.
r r r r5 r6 5GoogleIamAdminV1WorkforcePoolProviderOidcWebSsoConfigr r N)r r r r r r r9 r r r r jwksJson webSsoConfigr r r r r r sa ,
"
"1
%(''(_abc,##A&)
"
"1
%(''(_abc,r r c > \ rS rSrSr\R " SS5 rSrg)r i zvRepresentation of a client secret configured for the OIDC provider.
Fields:
value: The value of the client secret.
:GoogleIamAdminV1WorkforcePoolProviderOidcClientSecretValuer r N) r r r r r r r r r r r r r r s
!]_`
a%r r c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)r i aP Representation of the value of the client secret.
Fields:
plainText: Optional. Input only. The plain text of the client secret
value. For security reasons, this field is only used for input and will
never be populated in any response.
thumbprint: Output only. A thumbprint to represent the current client
secret value.
r r r N)
r r r r r r r9 plainText
thumbprintr r r r r r s) ##A&)$$Q'*r r c \ rS rSrSr " S S\R 5 r " S S\R 5 r\R " SSS 9r
\R " SS
5 r \R " SS 5 r
S rg
)r i a Configuration for web single sign-on for the OIDC provider.
Enums:
AssertionClaimsBehaviorValueValuesEnum: Required. The behavior for how
OIDC Claims are included in the `assertion` object used for attribute
mapping and attribute condition.
ResponseTypeValueValuesEnum: 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.
Fields:
additionalScopes: Optional. Additional scopes to request for in the OIDC
authentication request on top of scopes requested by default. By
default, the `openid`, `profile` and `email` scopes that are supported
by the identity provider are requested. Each additional scope may be at
most 256 characters. A maximum of 10 additional scopes may be
configured.
assertionClaimsBehavior: Required. The behavior for how OIDC Claims are
included in the `assertion` object used for attribute mapping and
attribute condition.
responseType: 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.
c $ \ rS rSrSrSrSrSrSrg)\GoogleIamAdminV1WorkforcePoolProviderOidcWebSsoConfig.AssertionClaimsBehaviorValueValuesEnumi a Required. The behavior for how OIDC Claims are included in the
`assertion` object used for attribute mapping and attribute condition.
Values:
ASSERTION_CLAIMS_BEHAVIOR_UNSPECIFIED: No assertion claims behavior
specified.
MERGE_USER_INFO_OVER_ID_TOKEN_CLAIMS: Merge the UserInfo Endpoint Claims
with ID Token Claims, preferring UserInfo Claim Values for the same
Claim Name. This option is available only for the Authorization Code
Flow.
ONLY_ID_TOKEN_CLAIMS: Only include ID Token Claims.
r r r r N) r r r r r %ASSERTION_CLAIMS_BEHAVIOR_UNSPECIFIED$MERGE_USER_INFO_OVER_ID_TOKEN_CLAIMSONLY_ID_TOKEN_CLAIMSr r r r &AssertionClaimsBehaviorValueValuesEnumr s -.)+,( r r c $ \ rS rSrSrSrSrSrSrg)QGoogleIamAdminV1WorkforcePoolProviderOidcWebSsoConfig.ResponseTypeValueValuesEnumi a 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.
Values:
RESPONSE_TYPE_UNSPECIFIED: No Response Type specified.
CODE: The `response_type=code` selection uses the Authorization Code
Flow for web sign-in. Requires a configured client secret.
ID_TOKEN: The `response_type=id_token` selection uses the Implicit Flow
for web sign-in.
r r r r N) r r r r r RESPONSE_TYPE_UNSPECIFIEDCODEID_TOKENr r r r ResponseTypeValueValuesEnumr s
!" DHr r r Tr
r r5 r N)r r r r r r r7 r r r9 additionalScopesr; assertionClaimsBehavior responseTyper r r r r r sd 2 y~~ "INN **1t< % / /0XZ[ \$$%BAF,r r c < \ rS rSrSr\R " S5 rSrg))GoogleIamAdminV1WorkforcePoolProviderSamli a Represents a SAML identity provider.
Fields:
idpMetadataXml: Required. SAML Identity provider configuration metadata
xml doc. The xml document should comply with [SAML 2.0
specification](https://docs.oasis-open.org/security/saml/v2.0/saml-
metadata-2.0-os.pdf). The max size of the acceptable xml document will
be bounded to 128k characters. The metadata xml document should satisfy
the following constraints: 1) Must contain an Identity Provider Entity
ID. 2) Must contain at least one non-expired signing key certificate. 3)
For each signing key: a) Valid from should be no more than 7 days from
now. b) Valid to should be no more than 25 years in the future. 4) Up to
3 IdP signing keys are allowed in the metadata xml. When updating the
provider's metadata xml, at least one non-expired signing key must
overlap with the existing metadata. This requirement is skipped if there
are no non-expired signing keys present in the existing metadata.
r r N r r r r r r r9 idpMetadataXmlr r r r r r $ ((+.r r c \ rS rSrSr\R " SSS9r\R " SS5 r \R " S5 r
S r g
) 'IamLocationsWorkforcePoolsCreateRequesti4 aL A IamLocationsWorkforcePoolsCreateRequest object.
Fields:
location: Optional. The location of the pool to create. Format:
`locations/{location}`.
workforcePool: A WorkforcePool resource to be passed as the request body.
workforcePoolId: Optional. The ID to use for the pool, which becomes the
final component of the resource name. The IDs must be a globally unique
string of 6 to 63 lowercase letters, digits, or hyphens. It must start
with a letter, and cannot have a trailing hyphen. The prefix `gcp-` is
reserved for use by Google, and may not be specified.
r Trequired
WorkforcePoolr r5 r N) r r r r r r r9 r r
workforcePoolworkforcePoolIdr r r r r r 4 s=
"
"1t
4((( !<- ))!,/r r c : \ rS rSrSr\R " SSS9rSrg)'IamLocationsWorkforcePoolsDeleteRequestiG zA IamLocationsWorkforcePoolsDeleteRequest object.
Fields:
name: Required. The name of the pool to delete. Format:
`locations/{location}/workforcePools/{workforce_pool_id}`
r Tr r Nr[ r r r r r G
q4 0$r r c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
-IamLocationsWorkforcePoolsGetIamPolicyRequestiR ai A IamLocationsWorkforcePoolsGetIamPolicyRequest object.
Fields:
getIamPolicyRequest: A GetIamPolicyRequest resource to be passed as the
request body.
resource: REQUIRED: The resource for which the policy is being requested.
See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the
appropriate value for this field.
r r r Tr r N r r r r r r r getIamPolicyRequestr9 resourcer r r r r r R / "../DaH
"
"1t
4(r r c : \ rS rSrSr\R " SSS9rSrg)$IamLocationsWorkforcePoolsGetRequestib zA IamLocationsWorkforcePoolsGetRequest object.
Fields:
name: Required. The name of the pool to retrieve. Format:
`locations/{location}/workforcePools/{workforce_pool_id}`
r Tr r Nr[ r r r r r b r r r c \ rS rSrSr\R " SSS9r\R " SS5 r \R " S5 r
S r g
) 4IamLocationsWorkforcePoolsInstalledAppsCreateRequestim a A IamLocationsWorkforcePoolsInstalledAppsCreateRequest object.
Fields:
parent: Required. The pool to create this workforce pool installed app in.
Format: `locations/{location}/workforcePools/{workforce_pool}`
workforcePoolInstalledApp: A WorkforcePoolInstalledApp resource to be
passed as the request body.
workforcePoolInstalledAppId: Required. The ID to use for the workforce
pool installed app, which becomes the final component of the resource
name. This value should be 4-32 characters, and may contain the
characters [a-z0-9-]. The prefix `gcp-` is reserved for use by Google,
and may not be specified.
r Tr WorkforcePoolInstalledAppr r5 r N) r r r r r r r9 parentr workforcePoolInstalledAppworkforcePoolInstalledAppIdr r r r r r m sA T 2& ' 4 45PRS T ) 5 5a 8 r r c ^ \ rS rSrSr\R " SSS9r\R " S5 r Sr
g) 4IamLocationsWorkforcePoolsInstalledAppsDeleteRequesti aj A IamLocationsWorkforcePoolsInstalledAppsDeleteRequest object.
Fields:
name: Required. The name of the workforce pool installed app to delete.
Format: `locations/{location}/workforcePools/{workforce_pool}/installedA
pps/{installed_app}`
validateOnly: Optional. If set, validate the request and preview the
response, but do not actually post it.
r Tr r r N r r r r r r r9 r: r validateOnlyr r r r r r +
q4 0$''*,r r c : \ rS rSrSr\R " SSS9rSrg)1IamLocationsWorkforcePoolsInstalledAppsGetRequesti zA IamLocationsWorkforcePoolsInstalledAppsGetRequest object.
Fields:
name: Required. The name of the workforce pool installed app to retrieve.
Format: `locations/{location}/workforcePools/{workforce_pool}/installedA
pps/{installed_app}`
r Tr r Nr[ r r r r
r
q4 0$r r
c \ rS rSrSr\R " S\R R S9r \R " S5 r \R " SSS9r \R " S 5 rS
rg ) 2IamLocationsWorkforcePoolsInstalledAppsListRequesti a A IamLocationsWorkforcePoolsInstalledAppsListRequest object.
Fields:
pageSize: Optional. The maximum number of workforce pool installed apps to
return. If unspecified, at most 50 workforce pool installed apps will be
returned. The maximum value is 100; values above 100 are truncated to
100.
pageToken: Optional. A page token, received from a previous
`ListWorkforcePoolInstalledApps` call. Provide this to retrieve the
subsequent page.
parent: Required. The parent to list installed apps, format:
'locations/{location}/workforcePools/{workforce_pool}'
showDeleted: Optional. Whether to return soft-deleted workforce pool
installed apps.
r r r r5 Tr r6 r Nr r r r r r r r r pageSizer9 pageTokenr r showDeletedr r r r r
r
Y
#
#Ay/@/@/F/F
G(##A&) T 2&&&q)+r r
c \ rS rSrSr\R " SSS9r\R " S5 r\R " SS5 r
S r g
) 3IamLocationsWorkforcePoolsInstalledAppsPatchRequesti a A IamLocationsWorkforcePoolsInstalledAppsPatchRequest object.
Fields:
name: Identifier. The resource name of the workforce pool installed app.
Format: `locations/{location}/workforcePools/{workforce_pool}/installedA
pps/{installed_app}`
updateMask: Required. The list of fields to update.
workforcePoolInstalledApp: A WorkforcePoolInstalledApp resource to be
passed as the request body.
r Tr r r r5 r N) r r r r r r r9 r:
updateMaskr r r r r r r r s@
q4 0$$$Q'* ' 4 45PRS Tr r c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
6IamLocationsWorkforcePoolsInstalledAppsUndeleteRequesti a A IamLocationsWorkforcePoolsInstalledAppsUndeleteRequest object.
Fields:
name: Required. The name of the workforce pool installed app to undelete.
Format: `locations/{location}/workforcePools/{workforce_pool}/installedA
pps/{installed_app}`
undeleteWorkforcePoolInstalledAppRequest: A
UndeleteWorkforcePoolInstalledAppRequest resource to be passed as the
request body.
r Tr (UndeleteWorkforcePoolInstalledAppRequestr r N) r r r r r r r9 r: r (undeleteWorkforcePoolInstalledAppRequestr r r r r r s0
q4 0$-6-C-CDnpq-r*r r c \ rS rSrSr\R " SSS9r\R " S\R R S9r \R " S5 r \R " S 5 r
\R " S
5 rS rg )
%IamLocationsWorkforcePoolsListRequesti a A IamLocationsWorkforcePoolsListRequest object.
Fields:
location: The location of the pool. Format: `locations/{location}`.
pageSize: The maximum number of pools to return. The default value is 50.
The maximum value is 100.
pageToken: A page token, received from a previous `ListWorkforcePools`
call. Provide this to retrieve the subsequent page.
parent: Required. The parent resource to list pools for. Format:
`organizations/{org-id}`.
showDeleted: Whether to return soft-deleted pools.
r Tr r r r5 r6 r r N)r r r r r r r9 r r r r r r r r r r r r r r r si
"
"1t
4(
#
#Ay/@/@/F/F
G(##A&) #&&&q)+r r c : \ rS rSrSr\R " SSS9rSrg).IamLocationsWorkforcePoolsOperationsGetRequesti znA IamLocationsWorkforcePoolsOperationsGetRequest object.
Fields:
name: The name of the operation resource.
r Tr r Nr[ r r r r r
q4 0$r r c \ rS rSrSr\R " SSS9r\R " S5 r\R " SS5 r
S r g
) &IamLocationsWorkforcePoolsPatchRequesti a5 A IamLocationsWorkforcePoolsPatchRequest object.
Fields:
name: Identifier. The resource name of the pool. Format:
`locations/{location}/workforcePools/{workforce_pool_id}`
updateMask: Required. The list of fields to update.
workforcePool: A WorkforcePool resource to be passed as the request body.
r Tr r r r5 r N) r r r r r r r9 r: r r r r r r r r r s=
q4 0$$$Q'*(( !<-r r c \ rS rSrSr\R " SSS9r\R " SS5 r \R " S5 r
S r g
) 0IamLocationsWorkforcePoolsProvidersCreateRequesti a> A IamLocationsWorkforcePoolsProvidersCreateRequest object.
Fields:
parent: Required. The pool to create this provider in. Format:
`locations/{location}/workforcePools/{workforce_pool_id}`
workforcePoolProvider: A WorkforcePoolProvider resource to be passed as
the request body.
workforcePoolProviderId: Required. The ID for the provider, which becomes
the final component of the resource name. This value must be 4-32
characters, and may contain the characters [a-z0-9-]. The prefix `gcp-`
is reserved for use by Google, and may not be specified.
r Tr WorkforcePoolProviderr r5 r N) r r r r r r r9 r r workforcePoolProviderworkforcePoolProviderIdr r r r r" r" s@ T 2H!L % 1 1! 4r r" c : \ rS rSrSr\R " SSS9rSrg)0IamLocationsWorkforcePoolsProvidersDeleteRequesti zA IamLocationsWorkforcePoolsProvidersDeleteRequest object.
Fields:
name: Required. The name of the provider to delete. Format: `locations/{lo
cation}/workforcePools/{workforce_pool_id}/providers/{provider_id}`
r Tr r Nr[ r r r r' r' r r r' c : \ rS rSrSr\R " SSS9rSrg)-IamLocationsWorkforcePoolsProvidersGetRequesti zA IamLocationsWorkforcePoolsProvidersGetRequest object.
Fields:
name: Required. The name of the provider to retrieve. Format: `locations/{
location}/workforcePools/{workforce_pool_id}/providers/{provider_id}`
r Tr r Nr[ r r r r) r) r r r) c \ rS rSrSr\R " SSS9r\R " SS5 r \R " S5 r
S r g
) 4IamLocationsWorkforcePoolsProvidersKeysCreateRequesti+ a A IamLocationsWorkforcePoolsProvidersKeysCreateRequest object.
Fields:
parent: Required. The provider to create this key in.
workforcePoolProviderKey: A WorkforcePoolProviderKey resource to be passed
as the request body.
workforcePoolProviderKeyId: Required. The ID to use for the key, which
becomes the final component of the resource name. This value must be
4-32 characters, and may contain the characters [a-z0-9-].
r Tr WorkforcePoolProviderKeyr r5 r N) r r r r r r r9 r r workforcePoolProviderKeyworkforcePoolProviderKeyIdr r r r r+ r+ + sA T 2& & 3 34NPQ R ( 4 4Q 7 r r+ c : \ rS rSrSr\R " SSS9rSrg)4IamLocationsWorkforcePoolsProvidersKeysDeleteRequesti< zyA IamLocationsWorkforcePoolsProvidersKeysDeleteRequest object.
Fields:
name: Required. The name of the key to delete.
r Tr r Nr[ r r r r0 r0 < r r r0 c : \ rS rSrSr\R " SSS9rSrg)1IamLocationsWorkforcePoolsProvidersKeysGetRequestiF zxA IamLocationsWorkforcePoolsProvidersKeysGetRequest object.
Fields:
name: Required. The name of the key to retrieve.
r Tr r Nr[ r r r r2 r2 F r r r2 c \ rS rSrSr\R " S\R R S9r \R " S5 r \R " SSS9r \R " S 5 rS
rg ) 2IamLocationsWorkforcePoolsProvidersKeysListRequestiP aS A IamLocationsWorkforcePoolsProvidersKeysListRequest object.
Fields:
pageSize: The maximum number of keys to return. If unspecified, all keys
are returned. The maximum value is 10; values above 10 are truncated to
10.
pageToken: A page token, received from a previous
`ListWorkforcePoolProviderKeys` call. Provide this to retrieve the
subsequent page.
parent: Required. The provider resource to list encryption keys for.
Format: `locations/{location}/workforcePools/{workforce_pool_id}/provide
rs/{provider_id}`
showDeleted: Whether to return soft-deleted keys.
r r r r5 Tr r6 r Nr r r r r4 r4 P Y
#
#Ay/@/@/F/F
G(##A&) T 2&&&q)+r r4 c : \ rS rSrSr\R " SSS9rSrg);IamLocationsWorkforcePoolsProvidersKeysOperationsGetRequestif z{A IamLocationsWorkforcePoolsProvidersKeysOperationsGetRequest object.
Fields:
name: The name of the operation resource.
r Tr r Nr[ r r r r7 r7 f r r r7 c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
6IamLocationsWorkforcePoolsProvidersKeysUndeleteRequestip a A IamLocationsWorkforcePoolsProvidersKeysUndeleteRequest object.
Fields:
name: Required. The name of the key to undelete.
undeleteWorkforcePoolProviderKeyRequest: A
UndeleteWorkforcePoolProviderKeyRequest resource to be passed as the
request body.
r Tr 'UndeleteWorkforcePoolProviderKeyRequestr r N) r r r r r r r9 r: r 'undeleteWorkforcePoolProviderKeyRequestr r r r r9 r9 p s0
q4 0$,5,B,BClno,p)r r9 c \ rS rSrSr\R " S\R R S9r \R " S5 r \R " SSS9r \R " S 5 rS
rg ) .IamLocationsWorkforcePoolsProvidersListRequesti~ a5 A IamLocationsWorkforcePoolsProvidersListRequest object.
Fields:
pageSize: The maximum number of providers to return. If unspecified, at
most 50 providers are returned. The maximum value is 100; values above
100 are truncated to 100.
pageToken: A page token, received from a previous
`ListWorkforcePoolProviders` call. Provide this to retrieve the
subsequent page.
parent: Required. The pool to list providers for. Format:
`locations/{location}/workforcePools/{workforce_pool_id}`
showDeleted: Whether to return soft-deleted providers.
r r r r5 Tr r6 r Nr r r r r= r= ~ Y
#
#Ay/@/@/F/F
G(##A&) T 2&&&q)+r r= c : \ rS rSrSr\R " SSS9rSrg)7IamLocationsWorkforcePoolsProvidersOperationsGetRequesti zwA IamLocationsWorkforcePoolsProvidersOperationsGetRequest object.
Fields:
name: The name of the operation resource.
r Tr r Nr[ r r r r@ r@ r r r@ c \ rS rSrSr\R " SSS9r\R " S5 r\R " SS5 r
S r g
) /IamLocationsWorkforcePoolsProvidersPatchRequesti ao A IamLocationsWorkforcePoolsProvidersPatchRequest object.
Fields:
name: Identifier. The resource name of the provider. Format: `locations/{l
ocation}/workforcePools/{workforce_pool_id}/providers/{provider_id}`
updateMask: Required. The list of fields to update.
workforcePoolProvider: A WorkforcePoolProvider resource to be passed as
the request body.
r Tr r r# r5 r N) r r r r r r r9 r: r r r$ r r r r rB rB s?
q4 0$$$Q'*#001H!Lr rB c \ rS rSrSr\R " SSS9r\R " SS5 r \R " S5 r
S r g
) ;IamLocationsWorkforcePoolsProvidersScimTenantsCreateRequesti aY A IamLocationsWorkforcePoolsProvidersScimTenantsCreateRequest object.
Fields:
parent: Required. Agentspace only. The parent to create SCIM tenant.
Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/
{provider}'
workforcePoolProviderScimTenant: A WorkforcePoolProviderScimTenant
resource to be passed as the request body.
workforcePoolProviderScimTenantId: 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-].
r Tr WorkforcePoolProviderScimTenantr r5 r N) r r r r r r r9 r r workforcePoolProviderScimTenant!workforcePoolProviderScimTenantIdr r r r rD rD sA T 2&$-$:$:;\^_$`!&/&;&;A&>#r rD c ^ \ rS rSrSr\R " S5 r\R " SSS9r Sr
g) ;IamLocationsWorkforcePoolsProvidersScimTenantsDeleteRequesti ar A IamLocationsWorkforcePoolsProvidersScimTenantsDeleteRequest object.
Fields:
hardDelete: Optional. Deletes the SCIM tenant immediately. This operation
cannot be undone.
name: Required. Agentspace only. The name of the scim tenant to delete.
Format: `locations/{location}/workforcePools/{workforce_pool}/providers/
{provider}/scimTenants/{scim_tenant}`
r r Tr r N) r r r r r r r
hardDeleter9 r: r r r r rI rI s+ %%a(* q4 0$r rI c : \ rS rSrSr\R " SSS9rSrg)8IamLocationsWorkforcePoolsProvidersScimTenantsGetRequesti a A IamLocationsWorkforcePoolsProvidersScimTenantsGetRequest object.
Fields:
name: Required. Agentspace only. The name of the SCIM tenant to retrieve.
Format: `locations/{location}/workforcePools/{workforce_pool}/providers/
{provider}/scimTenants/{scim_tenant}`
r Tr r Nr[ r r r rL rL r r rL c \ rS rSrSr\R " S\R R S9r \R " S5 r \R " SSS9r \R " S 5 rS
rg ) 9IamLocationsWorkforcePoolsProvidersScimTenantsListRequesti ay A IamLocationsWorkforcePoolsProvidersScimTenantsListRequest object.
Fields:
pageSize: Optional. Agentspace only. The maximum number of SCIM tenants to
return. If unspecified, at most 1 scim tenant will be returned.
pageToken: Optional. Agentspace only. A page token, received from a
previous `ListScimTenants` call. Provide this to retrieve the subsequent
page.
parent: Required. Agentspace only. The parent to list SCIM tenants.
Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/
{provider}'
showDeleted: Optional. Agentspace only. Whether to return soft-deleted
SCIM tenants.
r r r r5 Tr r6 r Nr r r r rN rN r5 r rN c \ rS rSrSr\R " SSS9r\R " S5 r\R " SS5 r
S r g
) :IamLocationsWorkforcePoolsProvidersScimTenantsPatchRequesti a A IamLocationsWorkforcePoolsProvidersScimTenantsPatchRequest object.
Fields:
name: Identifier. Agentspace only. The resource name of the SCIM Tenant.
Format: `locations/{location}/workforcePools/{workforce_pool}/providers/
{workforce_pool_provider}/scimTenants/{scim_tenant}`
updateMask: Optional. Agentspace only. The list of fields to update.
workforcePoolProviderScimTenant: A WorkforcePoolProviderScimTenant
resource to be passed as the request body.
r Tr r rE r5 r N) r r r r r r r9 r: r r rF r r r r rP rP s@
q4 0$$$Q'*$-$:$:;\^_$`!r rP c \ rS rSrSr\R " SSS9r\R " SS5 r \R " S5 r
S r g
) AIamLocationsWorkforcePoolsProvidersScimTenantsTokensCreateRequesti a A IamLocationsWorkforcePoolsProvidersScimTenantsTokensCreateRequest
object.
Fields:
parent: Required. Agentspace only. The parent tenant to create SCIM token.
Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/
{provider}/scimTenants/{scim_tenant}'
workforcePoolProviderScimToken: A WorkforcePoolProviderScimToken resource
to be passed as the request body.
workforcePoolProviderScimTokenId: Required. Agentspace only. The ID to use
for the SCIM token, which becomes the final component of the resource
name. This value should be 4-32 characters and follow the pattern:
"([a-z]([a-z0-9\\-]{2,30}[a-z0-9]))"
r Tr WorkforcePoolProviderScimTokenr r5 r N) r r r r r r r9 r r workforcePoolProviderScimToken workforcePoolProviderScimTokenIdr r r r rR rR sA
T 2&#,#9#9:Z\]#^ %.%:%:1%="r rR c : \ rS rSrSr\R " SSS9rSrg)AIamLocationsWorkforcePoolsProvidersScimTenantsTokensDeleteRequesti a$ A IamLocationsWorkforcePoolsProvidersScimTenantsTokensDeleteRequest
object.
Fields:
name: Required. Agentspace only. The name of the SCIM token to delete.
Format: `locations/{location}/workforcePools/{workforce_pool}/providers/
{provider}/scimTenants/{scim_tenant}/tokens/{token}`
r Tr r Nr[ r r r rW rW s
q4 0$r rW c : \ rS rSrSr\R " SSS9rSrg)>IamLocationsWorkforcePoolsProvidersScimTenantsTokensGetRequesti% a# A IamLocationsWorkforcePoolsProvidersScimTenantsTokensGetRequest object.
Fields:
name: Required. Agentspace only. The name of the SCIM token to retrieve.
Format: `locations/{location}/workforcePools/{workforce_pool}/providers/
{provider}/scimTenants/{scim_tenant}/tokens/{token}`
r Tr r Nr[ r r r rY rY % r r rY c \ rS rSrSr\R " S\R R S9r \R " S5 r \R " SSS9r \R " S 5 rS
rg ) ?IamLocationsWorkforcePoolsProvidersScimTenantsTokensListRequesti1 a A IamLocationsWorkforcePoolsProvidersScimTenantsTokensListRequest
object.
Fields:
pageSize: Optional. Agentspace only. The maximum number of scim tokens to
return. If unspecified, at most 2 SCIM tokens will be returned.
pageToken: Optional. Agentspace only. A page token, received from a
previous `ListWorkforcePoolProviderScimTokens` call. Provide this to
retrieve the subsequent page.
parent: Required. Agentspace only. The parent to list SCIM tokens. Format:
'locations/{location}/workforcePools/{workforce_pool}/providers/{provide
r}/scimTenants/{scim_tenant}'
showDeleted: Optional. Agentspace only. Whether to return soft-deleted
scim tokens.
r r r r5 Tr r6 r Nr r r r r[ r[ 1 r r r[ c \ rS rSrSr\R " SSS9r\R " S5 r\R " SS5 r
S r g
) @IamLocationsWorkforcePoolsProvidersScimTenantsTokensPatchRequestiH a A IamLocationsWorkforcePoolsProvidersScimTenantsTokensPatchRequest
object.
Fields:
name: Identifier. Agentspace only. The resource name of the SCIM Token.
Format: `locations/{location}/workforcePools/{workforce_pool}/providers/
{workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
updateMask: Optional. Agentspace only. The list of fields to update.
workforcePoolProviderScimToken: A WorkforcePoolProviderScimToken resource
to be passed as the request body.
r Tr r rS r5 r N) r r r r r r r9 r: r r rT r r r r r] r] H s@
q4 0$$$Q'*#,#9#9:Z\]#^ r r] c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
CIamLocationsWorkforcePoolsProvidersScimTenantsTokensUndeleteRequestiZ a A IamLocationsWorkforcePoolsProvidersScimTenantsTokensUndeleteRequest
object.
Fields:
name: Required. Agentspace only. The name of the SCIM token to undelete.
Format: `locations/{location}/workforcePools/{workforce_pool}/providers/
{provider}/scimTenants/{scim_tenant}/tokens/{token}`
undeleteWorkforcePoolProviderScimTokenRequest: A
UndeleteWorkforcePoolProviderScimTokenRequest resource to be passed as
the request body.
r Tr -UndeleteWorkforcePoolProviderScimTokenRequestr r N) r r r r r r r9 r: r -undeleteWorkforcePoolProviderScimTokenRequestr r r r r_ r_ Z s0
q4 0$2;2H2HIxz{2|/r r_ c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
=IamLocationsWorkforcePoolsProvidersScimTenantsUndeleteRequestik a A IamLocationsWorkforcePoolsProvidersScimTenantsUndeleteRequest object.
Fields:
name: Required. Agentspace only. The name of the SCIM tenant to undelete.
Format: `locations/{location}/workforcePools/{workforce_pool}/providers/
{provider}/scimTenants/{scim_tenant}`
undeleteWorkforcePoolProviderScimTenantRequest: A
UndeleteWorkforcePoolProviderScimTenantRequest resource to be passed as
the request body.
r Tr .UndeleteWorkforcePoolProviderScimTenantRequestr r N) r r r r r r r9 r: r .undeleteWorkforcePoolProviderScimTenantRequestr r r r rc rc k s0
q4 0$3<3I3IJz|}3~0r rc c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
2IamLocationsWorkforcePoolsProvidersUndeleteRequesti{ a_ A IamLocationsWorkforcePoolsProvidersUndeleteRequest object.
Fields:
name: Required. The name of the provider to undelete. Format: `locations/{
location}/workforcePools/{workforce_pool_id}/providers/{provider_id}`
undeleteWorkforcePoolProviderRequest: A
UndeleteWorkforcePoolProviderRequest resource to be passed as the
request body.
r Tr $UndeleteWorkforcePoolProviderRequestr r N) r r r r r r r9 r: r $undeleteWorkforcePoolProviderRequestr r r r rg rg { s0
q4 0$)2)?)?@fhi)j&r rg c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
-IamLocationsWorkforcePoolsSetIamPolicyRequesti ai A IamLocationsWorkforcePoolsSetIamPolicyRequest object.
Fields:
resource: REQUIRED: The resource for which the policy is being specified.
See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the
appropriate value for this field.
setIamPolicyRequest: A SetIamPolicyRequest resource to be passed as the
request body.
r Tr SetIamPolicyRequestr r N r r r r r r r9 r r setIamPolicyRequestr r r r rk rk /
"
"1t
4(!../DaHr rk c : \ rS rSrSr\R " SSS9rSrg)/IamLocationsWorkforcePoolsSubjectsDeleteRequesti a A IamLocationsWorkforcePoolsSubjectsDeleteRequest object.
Fields:
name: Required. The resource name of the WorkforcePoolSubject. Special
characters, like `/` and `:`, must be escaped, because all URLs need to
conform to the "When to Escape and Unescape" section of
[RFC3986](https://www.ietf.org/rfc/rfc2396.txt). Format: `locations/{loc
ation}/workforcePools/{workforce_pool_id}/subjects/{subject_id}`
r Tr r Nr[ r r r rq rq s
q4 0$r rq c : \ rS rSrSr\R " SSS9rSrg)6IamLocationsWorkforcePoolsSubjectsOperationsGetRequesti zvA IamLocationsWorkforcePoolsSubjectsOperationsGetRequest object.
Fields:
name: The name of the operation resource.
r Tr r Nr[ r r r rs rs r r rs c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
1IamLocationsWorkforcePoolsSubjectsUndeleteRequesti a$ A IamLocationsWorkforcePoolsSubjectsUndeleteRequest object.
Fields:
name: Required. The resource name of the WorkforcePoolSubject. Special
characters, like `/` and `:`, must be escaped, because all URLs need to
conform to the "When to Escape and Unescape" section of
[RFC3986](https://www.ietf.org/rfc/rfc2396.txt). Format: `locations/{loc
ation}/workforcePools/{workforce_pool_id}/subjects/{subject_id}`
undeleteWorkforcePoolSubjectRequest: A UndeleteWorkforcePoolSubjectRequest
resource to be passed as the request body.
r Tr #UndeleteWorkforcePoolSubjectRequestr r N) r r r r r r r9 r: r #undeleteWorkforcePoolSubjectRequestr r r r ru ru s0
q4 0$(1(>(>?dfg(h%r ru c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
3IamLocationsWorkforcePoolsTestIamPermissionsRequesti a A IamLocationsWorkforcePoolsTestIamPermissionsRequest object.
Fields:
resource: REQUIRED: The resource for which the policy detail is being
requested. See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the
appropriate value for this field.
testIamPermissionsRequest: A TestIamPermissionsRequest resource to be
passed as the request body.
r Tr TestIamPermissionsRequestr r N r r r r r r r9 r r testIamPermissionsRequestr r r r ry ry 0
"
"1t
4( ' 4 45PRS Tr ry c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
)IamLocationsWorkforcePoolsUndeleteRequesti a% A IamLocationsWorkforcePoolsUndeleteRequest object.
Fields:
name: Required. The name of the pool to undelete. Format:
`locations/{location}/workforcePools/{workforce_pool_id}`
undeleteWorkforcePoolRequest: A UndeleteWorkforcePoolRequest resource to
be passed as the request body.
r Tr UndeleteWorkforcePoolRequestr r N) r r r r r r r9 r: r undeleteWorkforcePoolRequestr r r r r r s0
q4 0$!*!7!78VXY!Z r r c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
"IamOrganizationsRolesCreateRequesti a' A IamOrganizationsRolesCreateRequest object.
Fields:
createRoleRequest: A CreateRoleRequest resource to be passed as the
request body.
parent: The `parent` parameter's value depends on the target resource for
the request, namely [projects](https://cloud.google.com/iam/docs/referen
ce/rest/v1/projects.roles) or [organizations](https://cloud.google.com/i
am/docs/reference/rest/v1/organizations.roles). Each resource type's
`parent` value format is described below: * [projects.roles.create](http
s://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/create):
`projects/{PROJECT_ID}`. This method creates project-level [custom
roles](https://cloud.google.com/iam/docs/understanding-custom-roles).
Example request URL:
`https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [organizat
ions.roles.create](https://cloud.google.com/iam/docs/reference/rest/v1/o
rganizations.roles/create): `organizations/{ORGANIZATION_ID}`. This
method creates organization-level [custom
roles](https://cloud.google.com/iam/docs/understanding-custom-roles).
Example request URL:
`https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles`
Note: Wildcard (*) values are invalid; you must specify a complete
project ID or organization ID.
rr r r Tr r N r r r r r r r createRoleRequestr9 r r r r r r r / 2 ,,-@!D T 2&r r c ^ \ rS rSrSr\R " S5 r\R " SSS9r Sr
g) "IamOrganizationsRolesDeleteRequesti a A IamOrganizationsRolesDeleteRequest object.
Fields:
etag: Used to perform a consistent read-modify-write.
name: The `name` parameter's value depends on the target resource for the
request, namely [projects](https://cloud.google.com/iam/docs/reference/r
est/v1/projects.roles) or [organizations](https://cloud.google.com/iam/d
ocs/reference/rest/v1/organizations.roles). Each resource type's `name`
value format is described below: * [projects.roles.delete](https://cloud
.google.com/iam/docs/reference/rest/v1/projects.roles/delete):
`projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only
[custom roles](https://cloud.google.com/iam/docs/understanding-custom-
roles) that have been created at the project level. Example request URL:
`https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_
ID}` * [organizations.roles.delete](https://cloud.google.com/iam/docs/re
ference/rest/v1/organizations.roles/delete):
`organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method
deletes only [custom
roles](https://cloud.google.com/iam/docs/understanding-custom-roles)
that have been created at the organization level. Example request URL: `
https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUS
TOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a
complete project ID or organization ID.
r r Tr r N r r r r r r
BytesFieldetagr9 r: r r r r r r + 2
a $ q4 0$r r c : \ rS rSrSr\R " SSS9rSrg) IamOrganizationsRolesGetRequesti a A IamOrganizationsRolesGetRequest object.
Fields:
name: The `name` parameter's value depends on the target resource for the
request, namely
[roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), [pro
jects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.role
s), or [organizations](https://cloud.google.com/iam/docs/reference/rest/
v1/organizations.roles). Each resource type's `name` value format is
described below: * [roles.get](https://cloud.google.com/iam/docs/referen
ce/rest/v1/roles/get): `roles/{ROLE_NAME}`. This method returns results
from all [predefined
roles](https://cloud.google.com/iam/docs/understanding-
roles#predefined_roles) in IAM. Example request URL:
`https://iam.googleapis.com/v1/roles/{ROLE_NAME}` * [projects.roles.get]
(https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/get)
: `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns
only [custom roles](https://cloud.google.com/iam/docs/understanding-
custom-roles) that have been created at the project level. Example
request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/
{CUSTOM_ROLE_ID}` * [organizations.roles.get](https://cloud.google.com/i
am/docs/reference/rest/v1/organizations.roles/get):
`organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method
returns only [custom
roles](https://cloud.google.com/iam/docs/understanding-custom-roles)
that have been created at the organization level. Example request URL: `
https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUS
TOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a
complete project ID or organization ID.
r Tr r Nr[ r r r r r >
q4 0$r r c \ rS rSrSr " S S\R 5 r\R " S\R R S9r \R " S5 r
\R " SS S
9r\R " S 5 r\R" " SS 5 rS
rg) IamOrganizationsRolesListRequesti@ a A IamOrganizationsRolesListRequest object.
Enums:
ViewValueValuesEnum: Optional view for the returned Role objects. When
`FULL` is specified, the `includedPermissions` field is returned, which
includes a list of all permissions in the role. The default value is
`BASIC`, which does not return the `includedPermissions` field.
Fields:
pageSize: Optional limit on the number of roles to include in the
response. The default is 300, and the maximum is 1,000.
pageToken: Optional pagination token returned in an earlier
ListRolesResponse.
parent: The `parent` parameter's value depends on the target resource for
the request, namely
[roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), [pro
jects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.role
s), or [organizations](https://cloud.google.com/iam/docs/reference/rest/
v1/organizations.roles). Each resource type's `parent` value format is
described below: * [roles.list](https://cloud.google.com/iam/docs/refere
nce/rest/v1/roles/list): An empty string. This method doesn't require a
resource; it simply returns all [predefined
roles](https://cloud.google.com/iam/docs/understanding-
roles#predefined_roles) in IAM. Example request URL:
`https://iam.googleapis.com/v1/roles` * [projects.roles.list](https://cl
oud.google.com/iam/docs/reference/rest/v1/projects.roles/list):
`projects/{PROJECT_ID}`. This method lists all project-level [custom
roles](https://cloud.google.com/iam/docs/understanding-custom-roles).
Example request URL:
`https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [organizat
ions.roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/org
anizations.roles/list): `organizations/{ORGANIZATION_ID}`. This method
lists all organization-level [custom
roles](https://cloud.google.com/iam/docs/understanding-custom-roles).
Example request URL:
`https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles`
Note: Wildcard (*) values are invalid; you must specify a complete
project ID or organization ID.
showDeleted: Include Roles that have been deleted.
view: Optional view for the returned Role objects. When `FULL` is
specified, the `includedPermissions` field is returned, which includes a
list of all permissions in the role. The default value is `BASIC`, which
does not return the `includedPermissions` field.
c \ rS rSrSrSrSrSrg)4IamOrganizationsRolesListRequest.ViewValueValuesEnumin t Optional view for the returned Role objects. When `FULL` is specified,
the `includedPermissions` field is returned, which includes a list of all
permissions in the role. The default value is `BASIC`, which does not
return the `includedPermissions` field.
Values:
BASIC: Omits the `included_permissions` field. This is the default
value.
FULL: Returns all fields.
r r r Nr r r r r BASICFULLr r r r ViewValueValuesEnumr n
E Dr r r r r r5 Tr r6 r r Nr r r r r r r7 r r r r r r9 r r r r r; viewr r r r r r @ } +Z
INN
#
#Ay/@/@/F/F
G(##A&) T 2&&&q)+ 2A 6$r r c \ rS rSrSr\R " SSS9r\R " SS5 r \R " S5 r
S r g
) !IamOrganizationsRolesPatchRequesti a A IamOrganizationsRolesPatchRequest object.
Fields:
name: The `name` parameter's value depends on the target resource for the
request, namely [projects](https://cloud.google.com/iam/docs/reference/r
est/v1/projects.roles) or [organizations](https://cloud.google.com/iam/d
ocs/reference/rest/v1/organizations.roles). Each resource type's `name`
value format is described below: * [projects.roles.patch](https://cloud.
google.com/iam/docs/reference/rest/v1/projects.roles/patch):
`projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only
[custom roles](https://cloud.google.com/iam/docs/understanding-custom-
roles) that have been created at the project level. Example request URL:
`https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_
ID}` * [organizations.roles.patch](https://cloud.google.com/iam/docs/ref
erence/rest/v1/organizations.roles/patch):
`organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method
updates only [custom
roles](https://cloud.google.com/iam/docs/understanding-custom-roles)
that have been created at the organization level. Example request URL: `
https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUS
TOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a
complete project ID or organization ID.
role: A Role resource to be passed as the request body.
updateMask: A mask describing which fields in the Role have changed.
r Tr rs r r5 r N r r r r r r r9 r: r rf r r r r r r r = 4
q4 0$ *$$$Q'*r r c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
$IamOrganizationsRolesUndeleteRequesti a A IamOrganizationsRolesUndeleteRequest object.
Fields:
name: The `name` parameter's value depends on the target resource for the
request, namely [projects](https://cloud.google.com/iam/docs/reference/r
est/v1/projects.roles) or [organizations](https://cloud.google.com/iam/d
ocs/reference/rest/v1/organizations.roles). Each resource type's `name`
value format is described below: * [projects.roles.undelete](https://clo
ud.google.com/iam/docs/reference/rest/v1/projects.roles/undelete):
`projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes
only [custom roles](https://cloud.google.com/iam/docs/understanding-
custom-roles) that have been created at the project level. Example
request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/
{CUSTOM_ROLE_ID}` * [organizations.roles.undelete](https://cloud.google.
com/iam/docs/reference/rest/v1/organizations.roles/undelete):
`organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method
undeletes only [custom
roles](https://cloud.google.com/iam/docs/understanding-custom-roles)
that have been created at the organization level. Example request URL: `
https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUS
TOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a
complete project ID or organization ID.
undeleteRoleRequest: A UndeleteRoleRequest resource to be passed as the
request body.
r Tr UndeleteRoleRequestr r N r r r r r r r9 r: r undeleteRoleRequestr r r r r r / 4
q4 0$!../DaHr r c \ rS rSrSr\R " SS5 r\R " S5 r \R " SSS9r
S r g
) -IamProjectsLocationsOauthClientsCreateRequesti a] A IamProjectsLocationsOauthClientsCreateRequest object.
Fields:
oauthClient: A OauthClient resource to be passed as the request body.
oauthClientId: Required. The ID to use for the OauthClient, which becomes
the final component of the resource name. This value should be a string
of 6 to 63 lowercase letters, digits, or hyphens. It must start with a
letter, and cannot have a trailing hyphen. The prefix `gcp-` is reserved
for use by Google, and may not be specified.
parent: Required. The parent resource to create the OauthClient in. The
only supported location is `global`.
OauthClientr r r5 Tr r N) r r r r r r r oauthClientr9
oauthClientIdr r r r r r r s= &&}a8+''*- T 2&r r c \ rS rSrSr\R " SS5 r\R " S5 r \R " SSS9r
S r g
) 8IamProjectsLocationsOauthClientsCredentialsCreateRequesti a5 A IamProjectsLocationsOauthClientsCredentialsCreateRequest object.
Fields:
oauthClientCredential: A OauthClientCredential resource to be passed as
the request body.
oauthClientCredentialId: Required. The ID to use for the
OauthClientCredential, which becomes the final component of the resource
name. This value should be 4-32 characters, and may contain the
characters [a-z0-9-]. The prefix `gcp-` is reserved for use by Google,
and may not be specified.
parent: Required. The parent resource to create the OauthClientCredential
in.
OauthClientCredentialr r r5 Tr r N) r r r r r r r oauthClientCredentialr9 oauthClientCredentialIdr r r r r r r s@ $001H!L % 1 1! 4 T 2&r r c ^ \ rS rSrSr\R " SSS9r\R " S5 r Sr
g) 8IamProjectsLocationsOauthClientsCredentialsDeleteRequesti as A IamProjectsLocationsOauthClientsCredentialsDeleteRequest object.
Fields:
name: Required. The name of the OauthClientCredential to delete. Format: `
projects/{project}/locations/{location}/oauthClients/{oauth_client}/cred
entials/{credential}`.
validateOnly: Optional. If set, validate the request and preview the
response, but do not actually post it.
r Tr r r Nr r r r r r r r r c : \ rS rSrSr\R " SSS9rSrg)5IamProjectsLocationsOauthClientsCredentialsGetRequesti zA IamProjectsLocationsOauthClientsCredentialsGetRequest object.
Fields:
name: Required. The name of the OauthClientCredential to retrieve. Format:
`projects/{project}/locations/{location}/oauthClients/{oauth_client}/cre
dentials/{credential}`.
r Tr r Nr[ r r r r r r r r c : \ rS rSrSr\R " SSS9rSrg)6IamProjectsLocationsOauthClientsCredentialsListRequesti zA IamProjectsLocationsOauthClientsCredentialsListRequest object.
Fields:
parent: Required. The parent to list OauthClientCredentials for.
r Tr r N) r r r r r r r9 r r r r r r r s T 2&r r c \ rS rSrSr\R " SSS9r\R " SS5 r \R " S5 r
S r g
) 7IamProjectsLocationsOauthClientsCredentialsPatchRequesti a A IamProjectsLocationsOauthClientsCredentialsPatchRequest object.
Fields:
name: Immutable. Identifier. The resource name of the
OauthClientCredential. Format: `projects/{project}/locations/{location}/
oauthClients/{oauth_client}/credentials/{credential}`
oauthClientCredential: A OauthClientCredential resource to be passed as
the request body.
updateMask: Required. The list of fields to update.
r Tr r r r5 r N) r r r r r r r9 r: r r r r r r r r r s?
q4 0$#001H!L$$Q'*r r c ^ \ rS rSrSr\R " SSS9r\R " S5 r Sr
g) -IamProjectsLocationsOauthClientsDeleteRequesti a? A IamProjectsLocationsOauthClientsDeleteRequest object.
Fields:
name: Required. The name of the OauthClient to delete. Format:
`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.
validateOnly: Optional. If set, validate the request and preview the
response, but do not actually post it.
r Tr r r Nr r r r r r s+
q4 0$''*,r r c : \ rS rSrSr\R " SSS9rSrg)*IamProjectsLocationsOauthClientsGetRequesti- zA IamProjectsLocationsOauthClientsGetRequest object.
Fields:
name: Required. The name of the OauthClient to retrieve. Format:
`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.
r Tr r Nr[ r r r r r - r r r c \ rS rSrSr\R " S\R R S9r \R " S5 r \R " SSS9r \R " S 5 rS
rg ) +IamProjectsLocationsOauthClientsListRequesti8 a A IamProjectsLocationsOauthClientsListRequest object.
Fields:
pageSize: Optional. The maximum number of OauthClients to return. If
unspecified, at most 50 OauthClients will be returned. The maximum value
is 100; values above 100 are truncated to 100.
pageToken: Optional. A page token, received from a previous
`ListOauthClients` call. Provide this to retrieve the subsequent page.
parent: Required. The parent to list OauthClients for.
showDeleted: Optional. Whether to return soft-deleted OauthClients.
r r r r5 Tr r6 r Nr r r r r r 8 sY
#
#Ay/@/@/F/F
G(##A&) T 2&&&q)+r r c \ rS rSrSr\R " SSS9r\R " SS5 r \R " S5 r
S r g
) ,IamProjectsLocationsOauthClientsPatchRequestiK aV A IamProjectsLocationsOauthClientsPatchRequest object.
Fields:
name: Immutable. Identifier. The resource name of the OauthClient. Format:
`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.
oauthClient: A OauthClient resource to be passed as the request body.
updateMask: Required. The list of fields to update.
r Tr r r r5 r N) r r r r r r r9 r: r r r r r r r r r K s=
q4 0$&&}a8+$$Q'*r r c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
/IamProjectsLocationsOauthClientsUndeleteRequestiZ a; A IamProjectsLocationsOauthClientsUndeleteRequest object.
Fields:
name: Required. The name of the OauthClient to undelete. Format:
`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.
undeleteOauthClientRequest: A UndeleteOauthClientRequest resource to be
passed as the request body.
r Tr UndeleteOauthClientRequestr r N) r r r r r r r9 r: r undeleteOauthClientRequestr r r r r r Z s0
q4 0$ ( 5 56RTU V r r c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
BIamProjectsLocationsWorkloadIdentityPoolsAddAttestationRuleRequestih a7 A IamProjectsLocationsWorkloadIdentityPoolsAddAttestationRuleRequest
object.
Fields:
addAttestationRuleRequest: A AddAttestationRuleRequest resource to be
passed as the request body.
resource: Required. The resource name of the managed identity or namespace
resource to add an attestation rule to.
r r r Tr r N r r r r r r r addAttestationRuleRequestr9 r r r r r r r h 0 ( 4 45PRS T
"
"1t
4(r r c \ rS rSrSr\R " SSS9r\R " SS5 r \R " S5 r
S r g
) 6IamProjectsLocationsWorkloadIdentityPoolsCreateRequestiw a3 A IamProjectsLocationsWorkloadIdentityPoolsCreateRequest object.
Fields:
parent: Required. The parent resource to create the pool in. The only
supported location is `global`.
workloadIdentityPool: A WorkloadIdentityPool resource to be passed as the
request body.
workloadIdentityPoolId: Required. The ID to use for the pool, which
becomes the final component of the resource name. This value should be
4-32 characters, and may contain the characters [a-z0-9-]. The prefix
`gcp-` is reserved for use by Google, and may not be specified.
r Tr WorkloadIdentityPoolr r5 r N) r r r r r r r9 r r workloadIdentityPoolworkloadIdentityPoolIdr r r r r r w s@ T 2&"//0FJ$003r r c : \ rS rSrSr\R " SSS9rSrg)6IamProjectsLocationsWorkloadIdentityPoolsDeleteRequesti z|A IamProjectsLocationsWorkloadIdentityPoolsDeleteRequest object.
Fields:
name: Required. The name of the pool to delete.
r Tr r Nr[ r r r r r r r r c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
IamProjectsLocationsWorkloadIdentityPoolsNamespacesListRequestiA a A IamProjectsLocationsWorkloadIdentityPoolsNamespacesListRequest object.
Fields:
pageSize: The maximum number of namespaces to return. If unspecified, at
most 50 namespaces are returned. The maximum value is 1000; values above
are 1000 truncated to 1000.
pageToken: A page token, received from a previous
`ListWorkloadIdentityPoolNamespaces` call. Provide this to retrieve the
subsequent page.
parent: Required. The parent resource to list namespaces for.
showDeleted: Whether to return soft-deleted namespaces.
r r r r5 Tr r6 r Nr r r r r r A r r r c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
]IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesAddAttestationRuleRequestiU aS A IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesAd
dAttestationRuleRequest object.
Fields:
addAttestationRuleRequest: A AddAttestationRuleRequest resource to be
passed as the request body.
resource: Required. The resource name of the managed identity or namespace
resource to add an attestation rule to.
r r r Tr r Nr r r r r r U r r r c \ rS rSrSr\R " SSS9r\R " SS5 r \R " S5 r
S r g
) QIamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesCreateRequestid a A IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesCr
eateRequest object.
Fields:
parent: Required. The parent resource to create the manage identity in.
The only supported location is `global`.
workloadIdentityPoolManagedIdentity: A WorkloadIdentityPoolManagedIdentity
resource to be passed as the request body.
workloadIdentityPoolManagedIdentityId: Required. The ID to use for the
managed identity. This value must: * contain at most 63 characters *
contain only lowercase alphanumeric characters or `-` * start with an
alphanumeric character * end with an alphanumeric character The prefix
"gcp-" will be reserved for future uses.
r Tr #WorkloadIdentityPoolManagedIdentityr r5 r N) r r r r r r r9 r r #workloadIdentityPoolManagedIdentity%workloadIdentityPoolManagedIdentityIdr r r r r r d sA
T 2&(1(>(>?dfg(h%*3*?*?*B'r r c : \ rS rSrSr\R " SSS9rSrg)QIamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesDeleteRequestiy zA IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesDe
leteRequest object.
Fields:
name: Required. The name of the managed identity to delete.
r Tr r Nr[ r r r r r y r r r c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
WIamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesGetIamPolicyRequesti a A IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesGe
tIamPolicyRequest object.
Fields:
getIamPolicyRequest: A GetIamPolicyRequest resource to be passed as the
request body.
resource: REQUIRED: The resource for which the policy is being requested.
See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the
appropriate value for this field.
r r r Tr r Nr r r r r r r r r c : \ rS rSrSr\R " SSS9rSrg)NIamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesGetRequesti zA IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesGe
tRequest object.
Fields:
name: Required. The name of the managed identity to retrieve.
r Tr r Nr[ r r r r r r r r c \ rS rSrSr\R " S5 r\R " S\R R S9r \R " S5 r \R " SSS 9r
S
rg ) _IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesListAttestationRulesRequesti a A IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesLi
stAttestationRulesRequest object.
Fields:
filter: Optional. A query filter. Supports the following function: *
`container_ids()`: Returns only the AttestationRules under the specific
container ids. The function expects a comma-delimited list with only
project numbers and must use the format `projects/`. For example:
`container_ids(projects/, projects/,...)`.
pageSize: Optional. The maximum number of AttestationRules to return. If
unspecified, at most 50 AttestationRules are returned. The maximum value
is 100; values above 100 are truncated to 100.
pageToken: Optional. A page token, received from a previous
`ListWorkloadIdentityPoolProviderKeys` call. Provide this to retrieve
the subsequent page.
resource: Required. The resource name of the managed identity or namespace
resource to list attestation rules of.
r r r r5 r6 Tr r Nr r r r r r r r r c \ rS rSrSr\R " S\R R S9r \R " S5 r \R " SSS9r \R " S 5 rS
rg ) OIamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesListRequesti aR A IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesLi
stRequest object.
Fields:
pageSize: The maximum number of managed identities to return. If
unspecified, at most 50 managed identities are returned. The maximum
value is 1000; values above are 1000 truncated to 1000.
pageToken: A page token, received from a previous
`ListWorkloadIdentityPoolManagedIdentities` call. Provide this to
retrieve the subsequent page.
parent: Required. The parent resource to list managed identities for.
showDeleted: Whether to return soft-deleted managed identities.
r r r r5 Tr r6 r Nr r r r r r r> r r c : \ rS rSrSr\R " SSS9rSrg)XIamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesOperationsGetRequesti zA IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesOp
erationsGetRequest object.
Fields:
name: The name of the operation resource.
r Tr r Nr[ r r r r r r r r c \ rS rSrSr\R " SSS9r\R " S5 r\R " SS5 r
S r g
) PIamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesPatchRequesti aW A IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesPa
tchRequest object.
Fields:
name: Output only. The resource name of the managed identity.
updateMask: Required. The list of fields to update.
workloadIdentityPoolManagedIdentity: A WorkloadIdentityPoolManagedIdentity
resource to be passed as the request body.
r Tr r r r5 r N) r r r r r r r9 r: r r r r r r r r r s@
q4 0$$$Q'*(1(>(>?dfg(h%r r c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
`IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesRemoveAttestationRuleRequesti aa A IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesRe
moveAttestationRuleRequest object.
Fields:
removeAttestationRuleRequest: A RemoveAttestationRuleRequest resource to
be passed as the request body.
resource: Required. The resource name of the managed identity or namespace
resource to remove an attestation rule from.
RemoveAttestationRuleRequestr r Tr r N r r r r r r r removeAttestationRuleRequestr9 r r r r r r r 0 "+!7!78VXY!Z
"
"1t
4(r r c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
^IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesSetAttestationRulesRequesti aV A IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesSe
tAttestationRulesRequest object.
Fields:
resource: Required. The resource name of the managed identity or namespace
resource to add an attestation rule to.
setAttestationRulesRequest: A SetAttestationRulesRequest resource to be
passed as the request body.
r Tr SetAttestationRulesRequestr r N r r r r r r r9 r r setAttestationRulesRequestr r r r r
r
0
"
"1t
4( ( 5 56RTU V r r
c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
WIamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesSetIamPolicyRequesti a A IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesSe
tIamPolicyRequest object.
Fields:
resource: REQUIRED: The resource for which the policy is being specified.
See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the
appropriate value for this field.
setIamPolicyRequest: A SetIamPolicyRequest resource to be passed as the
request body.
r Tr rl r r Nrm r r r r r /
"
"1t
4(!../DaHr r c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
]IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesTestIamPermissionsRequesti a A IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesTe
stIamPermissionsRequest object.
Fields:
resource: REQUIRED: The resource for which the policy detail is being
requested. See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the
appropriate value for this field.
testIamPermissionsRequest: A TestIamPermissionsRequest resource to be
passed as the request body.
r Tr rz r r Nr{ r r r r r 0
"
"1t
4( ' 4 45PRS Tr r c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
SIamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesUndeleteRequesti* aF A IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesUn
deleteRequest object.
Fields:
name: Required. The name of the managed identity to undelete.
undeleteWorkloadIdentityPoolManagedIdentityRequest: A
UndeleteWorkloadIdentityPoolManagedIdentityRequest resource to be passed
as the request body.
r Tr 2UndeleteWorkloadIdentityPoolManagedIdentityRequestr r N) r r r r r r r9 r: r 2undeleteWorkloadIdentityPoolManagedIdentityRequestr r r r r r * s;
q4 0$7@7M7M OC EF 8G4r r c \ rS rSrSr\R " SSS9r\R " SS5 r \R " S5 r
S r g
) `IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesCreateRequesti9 an A IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWo
rkloadSourcesCreateRequest object.
Fields:
parent: Required. The parent resource to create the workload source in.
workloadSource: A WorkloadSource resource to be passed as the request
body.
workloadSourceId: Required. The ID to use for the workload source, which
becomes the final component of the resource name. If ID of the
WorkloadSource resource determines which workloads may be matched. The
following formats are supported: - `project-{project_number}` matches
workloads within the referenced Google Cloud project.
r Tr WorkloadSourcer r5 r N r r r r r r r9 r r workloadSourceworkloadSourceIdr r r r r r 9 ? T 2& ))*:A>. **1-r r c ^ \ rS rSrSr\R " S5 r\R " SSS9rSr g) `IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesDeleteRequestiM a A IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWo
rkloadSourcesDeleteRequest object.
Fields:
etag: Optional. The etag for this workload source. If provided, it must
match the server's etag.
name: Required. The name of the workload source to delete.
r r Tr r N
r r r r r r r9 r r: r r r r r! r! M +
q !$ q4 0$r r! c : \ rS rSrSr\R " SSS9rSrg)]IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesGetRequesti[ zA IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWo
rkloadSourcesGetRequest object.
Fields:
name: Required. The name of the workload source to retrieve.
r Tr r Nr[ r r r r% r% [ r r r% c \ rS rSrSr\R " S\R R S9r \R " S5 r \R " SSS9r S r
g
) ^IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesListRequestif a A IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWo
rkloadSourcesListRequest object.
Fields:
pageSize: The maximum number of workload sources to return. If
unspecified, at most 50 workload sources are returned. The maximum value
is 1000; values above are 1000 truncated to 1000.
pageToken: A page token, received from a previous `ListWorkloadSources`
call. Provide this to retrieve the subsequent page.
parent: Required. The parent resource to list workload sources for.
r r r r5 Tr r Nr r r r r r r r r r r9 r r r r r r r' r' f I
#
#Ay/@/@/F/F
G(##A&) T 2&r r' c : \ rS rSrSr\R " SSS9rSrg)gIamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesOperationsGetRequestix zA IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWo
rkloadSourcesOperationsGetRequest object.
Fields:
name: The name of the operation resource.
r Tr r Nr[ r r r r+ r+ x r r r+ c \ rS rSrSr\R " SSS9r\R " S5 r\R " SS5 r
S r g
) _IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesPatchRequesti a A IamProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWo
rkloadSourcesPatchRequest object.
Fields:
name: Output only. The resource name of the workload source. If ID of the
WorkloadSource resource determines which workloads may be matched. The
following formats are supported: - `project-{project_number}` matches
workloads within the referenced Google Cloud project.
updateMask: Required. The list of fields to update.
workloadSource: A WorkloadSource resource to be passed as the request
body.
r Tr r r r5 r N r r r r r r r9 r: r r r r r r r r- r- >
q4 0$$$Q'* ))*:A>.r r- c : \ rS rSrSr\R " SSS9rSrg)GIamProjectsLocationsWorkloadIdentityPoolsNamespacesOperationsGetRequesti zA
IamProjectsLocationsWorkloadIdentityPoolsNamespacesOperationsGetRequest
object.
Fields:
name: The name of the operation resource.
r Tr r Nr[ r r r r1 r1 r r r1 c \ rS rSrSr\R " SSS9r\R " S5 r\R " SS5 r
S r g
) ?IamProjectsLocationsWorkloadIdentityPoolsNamespacesPatchRequesti a2 A IamProjectsLocationsWorkloadIdentityPoolsNamespacesPatchRequest
object.
Fields:
name: Output only. The resource name of the namespace.
updateMask: Required. The list of fields to update.
workloadIdentityPoolNamespace: A WorkloadIdentityPoolNamespace resource to
be passed as the request body.
r Tr r r r5 r N) r r r r r r r9 r: r r r r r r r r3 r3 s@
q4 0$$$Q'*"+"8"89XZ["\ r r3 c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
OIamProjectsLocationsWorkloadIdentityPoolsNamespacesRemoveAttestationRuleRequesti aP A IamProjectsLocationsWorkloadIdentityPoolsNamespacesRemoveAttestationRu
leRequest object.
Fields:
removeAttestationRuleRequest: A RemoveAttestationRuleRequest resource to
be passed as the request body.
resource: Required. The resource name of the managed identity or namespace
resource to remove an attestation rule from.
r r r Tr r Nr r r r r5 r5 r r r5 c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
MIamProjectsLocationsWorkloadIdentityPoolsNamespacesSetAttestationRulesRequesti aE A IamProjectsLocationsWorkloadIdentityPoolsNamespacesSetAttestationRules
Request object.
Fields:
resource: Required. The resource name of the managed identity or namespace
resource to add an attestation rule to.
setAttestationRulesRequest: A SetAttestationRulesRequest resource to be
passed as the request body.
r Tr r r r Nr r r r r7 r7 r r r7 c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
FIamProjectsLocationsWorkloadIdentityPoolsNamespacesSetIamPolicyRequesti a A IamProjectsLocationsWorkloadIdentityPoolsNamespacesSetIamPolicyRequest
object.
Fields:
resource: REQUIRED: The resource for which the policy is being specified.
See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the
appropriate value for this field.
setIamPolicyRequest: A SetIamPolicyRequest resource to be passed as the
request body.
r Tr rl r r Nrm r r r r9 r9 r r r9 c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
LIamProjectsLocationsWorkloadIdentityPoolsNamespacesTestIamPermissionsRequesti a A
IamProjectsLocationsWorkloadIdentityPoolsNamespacesTestIamPermissionsRequest
object.
Fields:
resource: REQUIRED: The resource for which the policy detail is being
requested. See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the
appropriate value for this field.
testIamPermissionsRequest: A TestIamPermissionsRequest resource to be
passed as the request body.
r Tr rz r r Nr{ r r r r; r; s0
"
"1t
4( ' 4 45PRS Tr r; c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
BIamProjectsLocationsWorkloadIdentityPoolsNamespacesUndeleteRequesti a! A IamProjectsLocationsWorkloadIdentityPoolsNamespacesUndeleteRequest
object.
Fields:
name: Required. The name of the namespace to undelete.
undeleteWorkloadIdentityPoolNamespaceRequest: A
UndeleteWorkloadIdentityPoolNamespaceRequest resource to be passed as
the request body.
r Tr ,UndeleteWorkloadIdentityPoolNamespaceRequestr r N) r r r r r r r9 r: r ,undeleteWorkloadIdentityPoolNamespaceRequestr r r r r= r= s0
q4 0$1:1G1GHvxy1z.r r= c \ rS rSrSr\R " SSS9r\R " SS5 r \R " S5 r
S r g
) OIamProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesCreateRequesti
a] A IamProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesCrea
teRequest object.
Fields:
parent: Required. The parent resource to create the workload source in.
workloadSource: A WorkloadSource resource to be passed as the request
body.
workloadSourceId: Required. The ID to use for the workload source, which
becomes the final component of the resource name. If ID of the
WorkloadSource resource determines which workloads may be matched. The
following formats are supported: - `project-{project_number}` matches
workloads within the referenced Google Cloud project.
r Tr r r r5 r Nr r r r rA rA
r r rA c ^ \ rS rSrSr\R " S5 r\R " SSS9rSr g) OIamProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesDeleteRequesti
a A IamProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesDele
teRequest object.
Fields:
etag: Optional. The etag for this workload source. If provided, it must
match the server's etag.
name: Required. The name of the workload source to delete.
r r Tr r Nr" r r r rC rC
r# r rC c : \ rS rSrSr\R " SSS9rSrg)LIamProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesGetRequesti$
zA
IamProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesGetRequest
object.
Fields:
name: Required. The name of the workload source to retrieve.
r Tr r Nr[ r r r rE rE $
r r rE c \ rS rSrSr\R " S\R R S9r \R " S5 r \R " SSS9r S r
g
) MIamProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesListRequesti0
a A IamProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesList
Request object.
Fields:
pageSize: The maximum number of workload sources to return. If
unspecified, at most 50 workload sources are returned. The maximum value
is 1000; values above are 1000 truncated to 1000.
pageToken: A page token, received from a previous `ListWorkloadSources`
call. Provide this to retrieve the subsequent page.
parent: Required. The parent resource to list workload sources for.
r r r r5 Tr r Nr( r r r rG rG 0
r) r rG c : \ rS rSrSr\R " SSS9rSrg)VIamProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesOperationsGetRequestiB
zA IamProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesOper
ationsGetRequest object.
Fields:
name: The name of the operation resource.
r Tr r Nr[ r r r rI rI B
r r rI c \ rS rSrSr\R " SSS9r\R " S5 r\R " SS5 r
S r g
) NIamProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesPatchRequestiM
a A IamProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesPatc
hRequest object.
Fields:
name: Output only. The resource name of the workload source. If ID of the
WorkloadSource resource determines which workloads may be matched. The
following formats are supported: - `project-{project_number}` matches
workloads within the referenced Google Cloud project.
updateMask: Required. The list of fields to update.
workloadSource: A WorkloadSource resource to be passed as the request
body.
r Tr r r r5 r Nr. r r r rK rK M
r/ r rK c : \ rS rSrSr\R " SSS9rSrg)=IamProjectsLocationsWorkloadIdentityPoolsOperationsGetRequesti`
z}A IamProjectsLocationsWorkloadIdentityPoolsOperationsGetRequest object.
Fields:
name: The name of the operation resource.
r Tr r Nr[ r r r rM rM `
r r rM c \ rS rSrSr\R " SSS9r\R " S5 r\R " SS5 r
S r g
) 5IamProjectsLocationsWorkloadIdentityPoolsPatchRequestij
a A IamProjectsLocationsWorkloadIdentityPoolsPatchRequest object.
Fields:
name: Output only. The resource name of the pool.
updateMask: Required. The list of fields to update.
workloadIdentityPool: A WorkloadIdentityPool resource to be passed as the
request body.
r Tr r r r5 r N) r r r r r r r9 r: r r r r r r r rO rO j
s?
q4 0$$$Q'*"//0FJr rO c \ rS rSrSr\R " SSS9r\R " SS5 r \R " S5 r
S r g
) ?IamProjectsLocationsWorkloadIdentityPoolsProvidersCreateRequestiy
a A IamProjectsLocationsWorkloadIdentityPoolsProvidersCreateRequest
object.
Fields:
parent: Required. The pool to create this provider in.
workloadIdentityPoolProvider: A WorkloadIdentityPoolProvider resource to
be passed as the request body.
workloadIdentityPoolProviderId: Required. The ID for the provider, which
becomes the final component of the resource name. This value must be
4-32 characters, and may contain the characters [a-z0-9-]. The prefix
`gcp-` is reserved for use by Google, and may not be specified.
r Tr WorkloadIdentityPoolProviderr r5 r N) r r r r r r r9 r r workloadIdentityPoolProvider workloadIdentityPoolProviderIdr r r r rQ rQ y
sA T 2&!*!7!78VXY!Z #,#8#8#; r rQ c : \ rS rSrSr\R " SSS9rSrg)?IamProjectsLocationsWorkloadIdentityPoolsProvidersDeleteRequesti
zA IamProjectsLocationsWorkloadIdentityPoolsProvidersDeleteRequest
object.
Fields:
name: Required. The name of the provider to delete.
r Tr r Nr[ r r r rV rV
r r rV c : \ rS rSrSr\R " SSS9rSrg)#r rZ c : \ rS rSrSr\R " SSS9rSrg)CIamProjectsLocationsWorkloadIdentityPoolsProvidersKeysDeleteRequesti
zA IamProjectsLocationsWorkloadIdentityPoolsProvidersKeysDeleteRequest
object.
Fields:
name: Required. The name of the encryption key to delete.
r Tr r Nr[ r r r r_ r_
r r r_ c : \ rS rSrSr\R " SSS9rSrg)@IamProjectsLocationsWorkloadIdentityPoolsProvidersKeysGetRequesti
zA IamProjectsLocationsWorkloadIdentityPoolsProvidersKeysGetRequest
object.
Fields:
name: Required. The name of the key to retrieve.
r Tr r Nr[ r r r ra ra
r r ra c \ rS rSrSr\R " S\R R S9r \R " S5 r \R " SSS9r \R " S 5 rS
rg ) AIamProjectsLocationsWorkloadIdentityPoolsProvidersKeysListRequesti
a A IamProjectsLocationsWorkloadIdentityPoolsProvidersKeysListRequest
object.
Fields:
pageSize: The maximum number of keys to return. If unspecified, all keys
are returned. The maximum value is 10; values above 10 are truncated to
10.
pageToken: A page token, received from a previous
`ListWorkloadIdentityPoolProviderKeys` call. Provide this to retrieve
the subsequent page.
parent: Required. The parent provider resource to list encryption keys
for.
showDeleted: Whether to return soft deleted resources as well.
r r r r5 Tr r6 r Nr r r r rc rc
r5 r rc c : \ rS rSrSr\R " SSS9rSrg)JIamProjectsLocationsWorkloadIdentityPoolsProvidersKeysOperationsGetRequesti
zA
IamProjectsLocationsWorkloadIdentityPoolsProvidersKeysOperationsGetRequest
object.
Fields:
name: The name of the operation resource.
r Tr r Nr[ r r r re re
r r re c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
EIamProjectsLocationsWorkloadIdentityPoolsProvidersKeysUndeleteRequesti
a- A IamProjectsLocationsWorkloadIdentityPoolsProvidersKeysUndeleteRequest
object.
Fields:
name: Required. The name of the encryption key to undelete.
undeleteWorkloadIdentityPoolProviderKeyRequest: A
UndeleteWorkloadIdentityPoolProviderKeyRequest resource to be passed as
the request body.
r Tr .UndeleteWorkloadIdentityPoolProviderKeyRequestr r N) r r r r r r r9 r: r .undeleteWorkloadIdentityPoolProviderKeyRequestr r r r rg rg
s0
q4 0$3<3I3IJz|}3~0r rg c \ rS rSrSr\R " S\R R S9r \R " S5 r \R " SSS9r \R " S 5 rS
rg ) =IamProjectsLocationsWorkloadIdentityPoolsProvidersListRequesti
a A IamProjectsLocationsWorkloadIdentityPoolsProvidersListRequest object.
Fields:
pageSize: The maximum number of providers to return. If unspecified, at
most 50 providers are returned. The maximum value is 100; values above
100 are truncated to 100.
pageToken: A page token, received from a previous
`ListWorkloadIdentityPoolProviders` call. Provide this to retrieve the
subsequent page.
parent: Required. The pool to list providers for.
showDeleted: Whether to return soft-deleted providers.
r r r r5 Tr r6 r Nr r r r rk rk
r r rk c : \ rS rSrSr\R " SSS9rSrg)FIamProjectsLocationsWorkloadIdentityPoolsProvidersOperationsGetRequesti zA IamProjectsLocationsWorkloadIdentityPoolsProvidersOperationsGetRequest
object.
Fields:
name: The name of the operation resource.
r Tr r Nr[ r r r rm rm r r rm c \ rS rSrSr\R " SSS9r\R " S5 r\R " SS5 r
S r g
) >IamProjectsLocationsWorkloadIdentityPoolsProvidersPatchRequesti a. A IamProjectsLocationsWorkloadIdentityPoolsProvidersPatchRequest object.
Fields:
name: Output only. The resource name of the provider.
updateMask: Required. The list of fields to update.
workloadIdentityPoolProvider: A WorkloadIdentityPoolProvider resource to
be passed as the request body.
r Tr r rR r5 r N) r r r r r r r9 r: r r rS r r r r ro ro s@
q4 0$$$Q'*!*!7!78VXY!Z r ro c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
AIamProjectsLocationsWorkloadIdentityPoolsProvidersUndeleteRequesti( a A IamProjectsLocationsWorkloadIdentityPoolsProvidersUndeleteRequest
object.
Fields:
name: Required. The name of the provider to undelete.
undeleteWorkloadIdentityPoolProviderRequest: A
UndeleteWorkloadIdentityPoolProviderRequest resource to be passed as the
request body.
r Tr +UndeleteWorkloadIdentityPoolProviderRequestr r N) r r r r r r r9 r: r +undeleteWorkloadIdentityPoolProviderRequestr r r r rq rq ( s0
q4 0$090F0FGtvw0x-r rq c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
EIamProjectsLocationsWorkloadIdentityPoolsRemoveAttestationRuleRequesti7 aE A IamProjectsLocationsWorkloadIdentityPoolsRemoveAttestationRuleRequest
object.
Fields:
removeAttestationRuleRequest: A RemoveAttestationRuleRequest resource to
be passed as the request body.
resource: Required. The resource name of the managed identity or namespace
resource to remove an attestation rule from.
r r r Tr r Nr r r r ru ru 7 r r ru c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
CIamProjectsLocationsWorkloadIdentityPoolsSetAttestationRulesRequestiF a: A IamProjectsLocationsWorkloadIdentityPoolsSetAttestationRulesRequest
object.
Fields:
resource: Required. The resource name of the managed identity or namespace
resource to add an attestation rule to.
setAttestationRulesRequest: A SetAttestationRulesRequest resource to be
passed as the request body.
r Tr r r r Nr r r r rw rw F r r rw c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
(>?dfg(h%r r} c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
IamProjectsRolesCreateRequesti a" A IamProjectsRolesCreateRequest object.
Fields:
createRoleRequest: A CreateRoleRequest resource to be passed as the
request body.
parent: The `parent` parameter's value depends on the target resource for
the request, namely [projects](https://cloud.google.com/iam/docs/referen
ce/rest/v1/projects.roles) or [organizations](https://cloud.google.com/i
am/docs/reference/rest/v1/organizations.roles). Each resource type's
`parent` value format is described below: * [projects.roles.create](http
s://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/create):
`projects/{PROJECT_ID}`. This method creates project-level [custom
roles](https://cloud.google.com/iam/docs/understanding-custom-roles).
Example request URL:
`https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [organizat
ions.roles.create](https://cloud.google.com/iam/docs/reference/rest/v1/o
rganizations.roles/create): `organizations/{ORGANIZATION_ID}`. This
method creates organization-level [custom
roles](https://cloud.google.com/iam/docs/understanding-custom-roles).
Example request URL:
`https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles`
Note: Wildcard (*) values are invalid; you must specify a complete
project ID or organization ID.
rr r r Tr r Nr r r r r r r r r c ^ \ rS rSrSr\R " S5 r\R " SSS9r Sr
g) IamProjectsRolesDeleteRequesti a A IamProjectsRolesDeleteRequest object.
Fields:
etag: Used to perform a consistent read-modify-write.
name: The `name` parameter's value depends on the target resource for the
request, namely [projects](https://cloud.google.com/iam/docs/reference/r
est/v1/projects.roles) or [organizations](https://cloud.google.com/iam/d
ocs/reference/rest/v1/organizations.roles). Each resource type's `name`
value format is described below: * [projects.roles.delete](https://cloud
.google.com/iam/docs/reference/rest/v1/projects.roles/delete):
`projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only
[custom roles](https://cloud.google.com/iam/docs/understanding-custom-
roles) that have been created at the project level. Example request URL:
`https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_
ID}` * [organizations.roles.delete](https://cloud.google.com/iam/docs/re
ference/rest/v1/organizations.roles/delete):
`organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method
deletes only [custom
roles](https://cloud.google.com/iam/docs/understanding-custom-roles)
that have been created at the organization level. Example request URL: `
https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUS
TOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a
complete project ID or organization ID.
r r Tr r Nr r r r r r r r r c : \ rS rSrSr\R " SSS9rSrg)IamProjectsRolesGetRequesti a A IamProjectsRolesGetRequest object.
Fields:
name: The `name` parameter's value depends on the target resource for the
request, namely
[roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), [pro
jects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.role
s), or [organizations](https://cloud.google.com/iam/docs/reference/rest/
v1/organizations.roles). Each resource type's `name` value format is
described below: * [roles.get](https://cloud.google.com/iam/docs/referen
ce/rest/v1/roles/get): `roles/{ROLE_NAME}`. This method returns results
from all [predefined
roles](https://cloud.google.com/iam/docs/understanding-
roles#predefined_roles) in IAM. Example request URL:
`https://iam.googleapis.com/v1/roles/{ROLE_NAME}` * [projects.roles.get]
(https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/get)
: `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns
only [custom roles](https://cloud.google.com/iam/docs/understanding-
custom-roles) that have been created at the project level. Example
request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/
{CUSTOM_ROLE_ID}` * [organizations.roles.get](https://cloud.google.com/i
am/docs/reference/rest/v1/organizations.roles/get):
`organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method
returns only [custom
roles](https://cloud.google.com/iam/docs/understanding-custom-roles)
that have been created at the organization level. Example request URL: `
https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUS
TOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a
complete project ID or organization ID.
r Tr r Nr[ r r r r r r r r c \ rS rSrSr " S S\R 5 r\R " S\R R S9r \R " S5 r
\R " SS S
9r\R " S 5 r\R" " SS 5 rS
rg)IamProjectsRolesListRequesti a A IamProjectsRolesListRequest object.
Enums:
ViewValueValuesEnum: Optional view for the returned Role objects. When
`FULL` is specified, the `includedPermissions` field is returned, which
includes a list of all permissions in the role. The default value is
`BASIC`, which does not return the `includedPermissions` field.
Fields:
pageSize: Optional limit on the number of roles to include in the
response. The default is 300, and the maximum is 1,000.
pageToken: Optional pagination token returned in an earlier
ListRolesResponse.
parent: The `parent` parameter's value depends on the target resource for
the request, namely
[roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), [pro
jects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.role
s), or [organizations](https://cloud.google.com/iam/docs/reference/rest/
v1/organizations.roles). Each resource type's `parent` value format is
described below: * [roles.list](https://cloud.google.com/iam/docs/refere
nce/rest/v1/roles/list): An empty string. This method doesn't require a
resource; it simply returns all [predefined
roles](https://cloud.google.com/iam/docs/understanding-
roles#predefined_roles) in IAM. Example request URL:
`https://iam.googleapis.com/v1/roles` * [projects.roles.list](https://cl
oud.google.com/iam/docs/reference/rest/v1/projects.roles/list):
`projects/{PROJECT_ID}`. This method lists all project-level [custom
roles](https://cloud.google.com/iam/docs/understanding-custom-roles).
Example request URL:
`https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [organizat
ions.roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/org
anizations.roles/list): `organizations/{ORGANIZATION_ID}`. This method
lists all organization-level [custom
roles](https://cloud.google.com/iam/docs/understanding-custom-roles).
Example request URL:
`https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles`
Note: Wildcard (*) values are invalid; you must specify a complete
project ID or organization ID.
showDeleted: Include Roles that have been deleted.
view: Optional view for the returned Role objects. When `FULL` is
specified, the `includedPermissions` field is returned, which includes a
list of all permissions in the role. The default value is `BASIC`, which
does not return the `includedPermissions` field.
c \ rS rSrSrSrSrSrg)/IamProjectsRolesListRequest.ViewValueValuesEnumi r r r r Nr r r r r r r r r r r r r5 Tr r6 r r Nr r r r r r r r r c \ rS rSrSr\R " SSS9r\R " SS5 r \R " S5 r
S r g
) IamProjectsRolesPatchRequesti% a A IamProjectsRolesPatchRequest object.
Fields:
name: The `name` parameter's value depends on the target resource for the
request, namely [projects](https://cloud.google.com/iam/docs/reference/r
est/v1/projects.roles) or [organizations](https://cloud.google.com/iam/d
ocs/reference/rest/v1/organizations.roles). Each resource type's `name`
value format is described below: * [projects.roles.patch](https://cloud.
google.com/iam/docs/reference/rest/v1/projects.roles/patch):
`projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only
[custom roles](https://cloud.google.com/iam/docs/understanding-custom-
roles) that have been created at the project level. Example request URL:
`https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_
ID}` * [organizations.roles.patch](https://cloud.google.com/iam/docs/ref
erence/rest/v1/organizations.roles/patch):
`organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method
updates only [custom
roles](https://cloud.google.com/iam/docs/understanding-custom-roles)
that have been created at the organization level. Example request URL: `
https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUS
TOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a
complete project ID or organization ID.
role: A Role resource to be passed as the request body.
updateMask: A mask describing which fields in the Role have changed.
r Tr rs r r5 r Nr r r r r r % r r r c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
IamProjectsRolesUndeleteRequestiE a A IamProjectsRolesUndeleteRequest object.
Fields:
name: The `name` parameter's value depends on the target resource for the
request, namely [projects](https://cloud.google.com/iam/docs/reference/r
est/v1/projects.roles) or [organizations](https://cloud.google.com/iam/d
ocs/reference/rest/v1/organizations.roles). Each resource type's `name`
value format is described below: * [projects.roles.undelete](https://clo
ud.google.com/iam/docs/reference/rest/v1/projects.roles/undelete):
`projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes
only [custom roles](https://cloud.google.com/iam/docs/understanding-
custom-roles) that have been created at the project level. Example
request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/
{CUSTOM_ROLE_ID}` * [organizations.roles.undelete](https://cloud.google.
com/iam/docs/reference/rest/v1/organizations.roles/undelete):
`organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method
undeletes only [custom
roles](https://cloud.google.com/iam/docs/understanding-custom-roles)
that have been created at the organization level. Example request URL: `
https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUS
TOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a
complete project ID or organization ID.
undeleteRoleRequest: A UndeleteRoleRequest resource to be passed as the
request body.
r Tr r r r Nr r r r r r E r r r c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
'IamProjectsServiceAccountsCreateRequestid a' A IamProjectsServiceAccountsCreateRequest object.
Fields:
createServiceAccountRequest: A CreateServiceAccountRequest resource to be
passed as the request body.
name: Required. The resource name of the project associated with the
service accounts, such as `projects/my-project-123`.
r r r Tr r N) r r r r r r r createServiceAccountRequestr9 r: r r r r r r d s0 !* 6 67TVW X q4 0$r r c : \ rS rSrSr\R " SSS9rSrg)'IamProjectsServiceAccountsDeleteRequestir a8 A IamProjectsServiceAccountsDeleteRequest object.
Fields:
name: Required. The resource name of the service account. Use one of the
following formats: *
`projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}` *
`projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}` As an alternative,
you can use the `-` wildcard character instead of the project ID: *
`projects/-/serviceAccounts/{EMAIL_ADDRESS}` *
`projects/-/serviceAccounts/{UNIQUE_ID}` When possible, avoid using the
`-` wildcard character, because it can cause response messages to
contain misleading error codes. For example, if you try to access the
service account `projects/-/serviceAccounts/fake@example.com`, which
does not exist, the response contains an HTTP `403 Forbidden` error
instead of a `404 Not Found` error.
r Tr r Nr[ r r r r r r "
q4 0$r r c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
(IamProjectsServiceAccountsDisableRequesti a A IamProjectsServiceAccountsDisableRequest object.
Fields:
disableServiceAccountRequest: A DisableServiceAccountRequest resource to
be passed as the request body.
name: The resource name of the service account. Use one of the following
formats: * `projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}` *
`projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}` As an alternative,
you can use the `-` wildcard character instead of the project ID: *
`projects/-/serviceAccounts/{EMAIL_ADDRESS}` *
`projects/-/serviceAccounts/{UNIQUE_ID}` When possible, avoid using the
`-` wildcard character, because it can cause response messages to
contain misleading error codes. For example, if you try to access the
service account `projects/-/serviceAccounts/fake@example.com`, which
does not exist, the response contains an HTTP `403 Forbidden` error
instead of a `404 Not Found` error.
r r r Tr r N) r r r r r r r disableServiceAccountRequestr9 r: r r r r r r s0 $ "+!7!78VXY!Z q4 0$r r c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
'IamProjectsServiceAccountsEnableRequesti a A IamProjectsServiceAccountsEnableRequest object.
Fields:
enableServiceAccountRequest: A EnableServiceAccountRequest resource to be
passed as the request body.
name: The resource name of the service account. Use one of the following
formats: * `projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}` *
`projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}` As an alternative,
you can use the `-` wildcard character instead of the project ID: *
`projects/-/serviceAccounts/{EMAIL_ADDRESS}` *
`projects/-/serviceAccounts/{UNIQUE_ID}` When possible, avoid using the
`-` wildcard character, because it can cause response messages to
contain misleading error codes. For example, if you try to access the
service account `projects/-/serviceAccounts/fake@example.com`, which
does not exist, the response contains an HTTP `403 Forbidden` error
instead of a `404 Not Found` error.
r r r Tr r N) r r r r r r r enableServiceAccountRequestr9 r: r r r r r r s0 $ !* 6 67TVW X q4 0$r r c \ rS rSrSr\R " S\R R S9r \R " SSS9r Sr g )
-IamProjectsServiceAccountsGetIamPolicyRequesti a9 A IamProjectsServiceAccountsGetIamPolicyRequest object.
Fields:
options_requestedPolicyVersion: Optional. The maximum policy version that
will be used to format the policy. Valid values are 0, 1, and 3.
Requests specifying an invalid value will be rejected. Requests for
policies with any conditional role bindings must specify version 3.
Policies with no conditional role bindings may specify any valid value
or leave the field unset. The policy in the response might use the
policy version that you specified, or it might use a lower policy
version. For example, if you specify version 3, but the policy has no
conditional role bindings, the response uses version 1. To learn which
resources support conditions in their IAM policies, see the [IAM
documentation](https://cloud.google.com/iam/help/conditions/resource-
policies).
resource: REQUIRED: The resource for which the policy is being requested.
See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the
appropriate value for this field.
r r r Tr r N)
r r r r r r r r r options_requestedPolicyVersionr9 r r r r r r r s: * $-#9#9!YEVEVE\E\#]
"
"1t
4(r r c : \ rS rSrSr\R " SSS9rSrg)$IamProjectsServiceAccountsGetRequesti a5 A IamProjectsServiceAccountsGetRequest object.
Fields:
name: Required. The resource name of the service account. Use one of the
following formats: *
`projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}` *
`projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}` As an alternative,
you can use the `-` wildcard character instead of the project ID: *
`projects/-/serviceAccounts/{EMAIL_ADDRESS}` *
`projects/-/serviceAccounts/{UNIQUE_ID}` When possible, avoid using the
`-` wildcard character, because it can cause response messages to
contain misleading error codes. For example, if you try to access the
service account `projects/-/serviceAccounts/fake@example.com`, which
does not exist, the response contains an HTTP `403 Forbidden` error
instead of a `404 Not Found` error.
r Tr r Nr[ r r r r r r r r c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
+IamProjectsServiceAccountsKeysCreateRequesti a A IamProjectsServiceAccountsKeysCreateRequest object.
Fields:
createServiceAccountKeyRequest: A CreateServiceAccountKeyRequest resource
to be passed as the request body.
name: Required. The resource name of the service account. Use one of the
following formats: *
`projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}` *
`projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}` As an alternative,
you can use the `-` wildcard character instead of the project ID: *
`projects/-/serviceAccounts/{EMAIL_ADDRESS}` *
`projects/-/serviceAccounts/{UNIQUE_ID}` When possible, avoid using the
`-` wildcard character, because it can cause response messages to
contain misleading error codes. For example, if you try to access the
service account `projects/-/serviceAccounts/fake@example.com`, which
does not exist, the response contains an HTTP `403 Forbidden` error
instead of a `404 Not Found` error.
rv r r Tr r N) r r r r r r r createServiceAccountKeyRequestr9 r: r r r r r r s0 & $-#9#9:Z\]#^ q4 0$r r c : \ rS rSrSr\R " SSS9rSrg)+IamProjectsServiceAccountsKeysDeleteRequesti a A IamProjectsServiceAccountsKeysDeleteRequest object.
Fields:
name: Required. The resource name of the service account key. Use one of
the following formats: *
`projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}/keys/{KEY_ID}` *
`projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}/keys/{KEY_ID}` As an
alternative, you can use the `-` wildcard character instead of the
project ID: * `projects/-/serviceAccounts/{EMAIL_ADDRESS}/keys/{KEY_ID}`
* `projects/-/serviceAccounts/{UNIQUE_ID}/keys/{KEY_ID}` When possible,
avoid using the `-` wildcard character, because it can cause response
messages to contain misleading error codes. For example, if you try to
access the service account key
`projects/-/serviceAccounts/fake@example.com/keys/fake-key`, which does
not exist, the response contains an HTTP `403 Forbidden` error instead
of a `404 Not Found` error.
r Tr r Nr[ r r r r r s $
q4 0$r r c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
,IamProjectsServiceAccountsKeysDisableRequesti
a A IamProjectsServiceAccountsKeysDisableRequest object.
Fields:
disableServiceAccountKeyRequest: A DisableServiceAccountKeyRequest
resource to be passed as the request body.
name: Required. The resource name of the service account key. Use one of
the following formats: *
`projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}/keys/{KEY_ID}` *
`projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}/keys/{KEY_ID}` As an
alternative, you can use the `-` wildcard character instead of the
project ID: * `projects/-/serviceAccounts/{EMAIL_ADDRESS}/keys/{KEY_ID}`
* `projects/-/serviceAccounts/{UNIQUE_ID}/keys/{KEY_ID}` When possible,
avoid using the `-` wildcard character, because it can cause response
messages to contain misleading error codes. For example, if you try to
access the service account key
`projects/-/serviceAccounts/fake@example.com/keys/fake-key`, which does
not exist, the response contains an HTTP `403 Forbidden` error instead
of a `404 Not Found` error.
r r r Tr r N) r r r r r r r disableServiceAccountKeyRequestr9 r: r r r r r r
s0 ( %.$:$:;\^_$`! q4 0$r r c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
+IamProjectsServiceAccountsKeysEnableRequesti+
a A IamProjectsServiceAccountsKeysEnableRequest object.
Fields:
enableServiceAccountKeyRequest: A EnableServiceAccountKeyRequest resource
to be passed as the request body.
name: Required. The resource name of the service account key. Use one of
the following formats: *
`projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}/keys/{KEY_ID}` *
`projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}/keys/{KEY_ID}` As an
alternative, you can use the `-` wildcard character instead of the
project ID: * `projects/-/serviceAccounts/{EMAIL_ADDRESS}/keys/{KEY_ID}`
* `projects/-/serviceAccounts/{UNIQUE_ID}/keys/{KEY_ID}` When possible,
avoid using the `-` wildcard character, because it can cause response
messages to contain misleading error codes. For example, if you try to
access the service account key
`projects/-/serviceAccounts/fake@example.com/keys/fake-key`, which does
not exist, the response contains an HTTP `403 Forbidden` error instead
of a `404 Not Found` error.
r r r Tr r N) r r r r r r r enableServiceAccountKeyRequestr9 r: r r r r r r +
s0 ( $-#9#9:Z\]#^ q4 0$r r c \ rS rSrSr " S S\R 5 r\R " SSS9r \R " SS5 r S r g
) (IamProjectsServiceAccountsKeysGetRequestiD
a A IamProjectsServiceAccountsKeysGetRequest object.
Enums:
PublicKeyTypeValueValuesEnum: Optional. The output format of the public
key. The default is `TYPE_NONE`, which means that the public key is not
returned.
Fields:
name: Required. The resource name of the service account key. Use one of
the following formats: *
`projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}/keys/{KEY_ID}` *
`projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}/keys/{KEY_ID}` As an
alternative, you can use the `-` wildcard character instead of the
project ID: * `projects/-/serviceAccounts/{EMAIL_ADDRESS}/keys/{KEY_ID}`
* `projects/-/serviceAccounts/{UNIQUE_ID}/keys/{KEY_ID}` When possible,
avoid using the `-` wildcard character, because it can cause response
messages to contain misleading error codes. For example, if you try to
access the service account key
`projects/-/serviceAccounts/fake@example.com/keys/fake-key`, which does
not exist, the response contains an HTTP `403 Forbidden` error instead
of a `404 Not Found` error.
publicKeyType: Optional. The output format of the public key. The default
is `TYPE_NONE`, which means that the public key is not returned.
c $ \ rS rSrSrSrSrSrSrg)EIamProjectsServiceAccountsKeysGetRequest.PublicKeyTypeValueValuesEnumi^
zOptional. The output format of the public key. The default is
`TYPE_NONE`, which means that the public key is not returned.
Values:
TYPE_NONE: Do not return the public key.
TYPE_X509_PEM_FILE: X509 PEM format.
TYPE_RAW_PUBLIC_KEY: Raw public key.
r r r r N) r r r r r TYPE_NONETYPE_X509_PEM_FILETYPE_RAW_PUBLIC_KEYr r r r PublicKeyTypeValueValuesEnumr ^
s Ir r r Tr r r N)
r r r r r r r7 r r9 r: r;
publicKeyTyper r r r r r D
s> 2 Y^^
q4 0$%%&DaH-r r c \ rS rSrSr " S S\R 5 r\R " SSSS9r \R " SSS 9r S
r g ) )IamProjectsServiceAccountsKeysListRequestio
a A IamProjectsServiceAccountsKeysListRequest object.
Enums:
KeyTypesValueValuesEnum: Filters the types of keys the user wants to
include in the list response. Duplicate key types are not allowed. If no
key type is provided, all keys are returned.
Fields:
keyTypes: Filters the types of keys the user wants to include in the list
response. Duplicate key types are not allowed. If no key type is
provided, all keys are returned.
name: Required. The resource name of the service account. Use one of the
following formats: *
`projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}` *
`projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}` As an alternative,
you can use the `-` wildcard character instead of the project ID: *
`projects/-/serviceAccounts/{EMAIL_ADDRESS}` *
`projects/-/serviceAccounts/{UNIQUE_ID}` When possible, avoid using the
`-` wildcard character, because it can cause response messages to
contain misleading error codes. For example, if you try to access the
service account `projects/-/serviceAccounts/fake@example.com`, which
does not exist, the response contains an HTTP `403 Forbidden` error
instead of a `404 Not Found` error.
c $ \ rS rSrSrSrSrSrSrg)AIamProjectsServiceAccountsKeysListRequest.KeyTypesValueValuesEnumi
a Filters the types of keys the user wants to include in the list
response. Duplicate key types are not allowed. If no key type is provided,
all keys are returned.
Values:
KEY_TYPE_UNSPECIFIED: Unspecified key type. The presence of this in the
message will immediately result in an error.
USER_MANAGED: User-managed keys (managed and rotated by the user).
SYSTEM_MANAGED: System-managed keys (managed and rotated by Google).
r r r r N r r r r r KEY_TYPE_UNSPECIFIED USER_MANAGEDSYSTEM_MANAGEDr r r r KeyTypesValueValuesEnumr
s LNr r r Tr
r r r N)
r r r r r r r7 r r; keyTypesr9 r: r r r r r r o
s@ 2
!:A
M( q4 0$r r c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
+IamProjectsServiceAccountsKeysUploadRequesti
a A IamProjectsServiceAccountsKeysUploadRequest object.
Fields:
name: The resource name of the service account key. Use one of the
following formats: *
`projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}` *
`projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}` As an alternative,
you can use the `-` wildcard character instead of the project ID: *
`projects/-/serviceAccounts/{EMAIL_ADDRESS}` *
`projects/-/serviceAccounts/{UNIQUE_ID}` When possible, avoid using the
`-` wildcard character, because it can cause response messages to
contain misleading error codes. For example, if you try to access the
service account `projects/-/serviceAccounts/fake@example.com`, which
does not exist, the response contains an HTTP `403 Forbidden` error
instead of a `404 Not Found` error.
uploadServiceAccountKeyRequest: A UploadServiceAccountKeyRequest resource
to be passed as the request body.
r Tr UploadServiceAccountKeyRequestr r N) r r r r r r r9 r: r uploadServiceAccountKeyRequestr r r r r r
s0 &
q4 0$#,#9#9:Z\]#^ r r c \ rS rSrSr\R " SSS9r\R " S\R R S9r \R " S5 r S r
g
) %IamProjectsServiceAccountsListRequesti
a< A IamProjectsServiceAccountsListRequest object.
Fields:
name: Required. The resource name of the project associated with the
service accounts, such as `projects/my-project-123`.
pageSize: Optional limit on the number of service accounts to include in
the response. Further accounts can subsequently be obtained by including
the ListServiceAccountsResponse.next_page_token in a subsequent request.
The default is 20, and the maximum is 100.
pageToken: Optional pagination token returned in an earlier
ListServiceAccountsResponse.next_page_token.
r Tr r r r5 r N)r r r r r r r9 r: r r r r r r r r r r r
sI
q4 0$
#
#Ay/@/@/F/F
G(##A&)r r c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
&IamProjectsServiceAccountsPatchRequesti
a A IamProjectsServiceAccountsPatchRequest object.
Fields:
name: The resource name of the service account. Use one of the following
formats: * `projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}` *
`projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}` As an alternative,
you can use the `-` wildcard character instead of the project ID: *
`projects/-/serviceAccounts/{EMAIL_ADDRESS}` *
`projects/-/serviceAccounts/{UNIQUE_ID}` When possible, avoid using the
`-` wildcard character, because it can cause response messages to
contain misleading error codes. For example, if you try to access the
service account `projects/-/serviceAccounts/fake@example.com`, which
does not exist, the response contains an HTTP `403 Forbidden` error
instead of a `404 Not Found` error.
patchServiceAccountRequest: A PatchServiceAccountRequest resource to be
passed as the request body.
r Tr PatchServiceAccountRequestr r N) r r r r r r r9 r: r patchServiceAccountRequestr r r r r r
s0 $
q4 0$ ( 5 56RTU V r r c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
-IamProjectsServiceAccountsSetIamPolicyRequesti
ai A IamProjectsServiceAccountsSetIamPolicyRequest object.
Fields:
resource: REQUIRED: The resource for which the policy is being specified.
See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the
appropriate value for this field.
setIamPolicyRequest: A SetIamPolicyRequest resource to be passed as the
request body.
r Tr rl r r Nrm r r r r r
ro r r c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
)IamProjectsServiceAccountsSignBlobRequesti
a A IamProjectsServiceAccountsSignBlobRequest object.
Fields:
name: Required. Deprecated. [Migrate to Service Account Credentials
API](https://cloud.google.com/iam/help/credentials/migrate-api). The
resource name of the service account. Use one of the following formats:
* `projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}` *
`projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}` As an alternative,
you can use the `-` wildcard character instead of the project ID: *
`projects/-/serviceAccounts/{EMAIL_ADDRESS}` *
`projects/-/serviceAccounts/{UNIQUE_ID}` When possible, avoid using the
`-` wildcard character, because it can cause response messages to
contain misleading error codes. For example, if you try to access the
service account `projects/-/serviceAccounts/fake@example.com`, which
does not exist, the response contains an HTTP `403 Forbidden` error
instead of a `404 Not Found` error.
signBlobRequest: A SignBlobRequest resource to be passed as the request
body.
r Tr SignBlobRequestr r N) r r r r r r r9 r: r signBlobRequestr r r r r r
s. (
q4 0$ **+.r r c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
3IamProjectsServiceAccountsTestIamPermissionsRequesti a A IamProjectsServiceAccountsTestIamPermissionsRequest object.
Fields:
resource: REQUIRED: The resource for which the policy detail is being
requested. See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the
appropriate value for this field.
testIamPermissionsRequest: A TestIamPermissionsRequest resource to be
passed as the request body.
r Tr rz r r Nr{ r r r r r r} r r c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
)IamProjectsServiceAccountsUndeleteRequesti0 a A IamProjectsServiceAccountsUndeleteRequest object.
Fields:
name: The resource name of the service account. Use one of the following
formats: * `projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}` *
`projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}` As an alternative,
you can use the `-` wildcard character instead of the project ID: *
`projects/-/serviceAccounts/{EMAIL_ADDRESS}` *
`projects/-/serviceAccounts/{UNIQUE_ID}` When possible, avoid using the
`-` wildcard character, because it can cause response messages to
contain misleading error codes. For example, if you try to access the
service account `projects/-/serviceAccounts/fake@example.com`, which
does not exist, the response contains an HTTP `403 Forbidden` error
instead of a `404 Not Found` error.
undeleteServiceAccountRequest: A UndeleteServiceAccountRequest resource to
be passed as the request body.
r Tr UndeleteServiceAccountRequestr r N) r r r r r r r9 r: r undeleteServiceAccountRequestr r r r r r 0 s0 $
q4 0$"+"8"89XZ["\ r r c : \ rS rSrSr\R " SSS9rSrg)IamRolesGetRequestiG a A IamRolesGetRequest object.
Fields:
name: The `name` parameter's value depends on the target resource for the
request, namely
[roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), [pro
jects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.role
s), or [organizations](https://cloud.google.com/iam/docs/reference/rest/
v1/organizations.roles). Each resource type's `name` value format is
described below: * [roles.get](https://cloud.google.com/iam/docs/referen
ce/rest/v1/roles/get): `roles/{ROLE_NAME}`. This method returns results
from all [predefined
roles](https://cloud.google.com/iam/docs/understanding-
roles#predefined_roles) in IAM. Example request URL:
`https://iam.googleapis.com/v1/roles/{ROLE_NAME}` * [projects.roles.get]
(https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/get)
: `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns
only [custom roles](https://cloud.google.com/iam/docs/understanding-
custom-roles) that have been created at the project level. Example
request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/
{CUSTOM_ROLE_ID}` * [organizations.roles.get](https://cloud.google.com/i
am/docs/reference/rest/v1/organizations.roles/get):
`organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method
returns only [custom
roles](https://cloud.google.com/iam/docs/understanding-custom-roles)
that have been created at the organization level. Example request URL: `
https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUS
TOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a
complete project ID or organization ID.
r Tr r Nr[ r r r r r G r r r c \ rS rSrSr " S S\R 5 r\R " S\R R S9r \R " S5 r
\R " S5 r\R " S 5 r\R" " SS
5 rS rg )
IamRolesListRequestij a A IamRolesListRequest object.
Enums:
ViewValueValuesEnum: Optional view for the returned Role objects. When
`FULL` is specified, the `includedPermissions` field is returned, which
includes a list of all permissions in the role. The default value is
`BASIC`, which does not return the `includedPermissions` field.
Fields:
pageSize: Optional limit on the number of roles to include in the
response. The default is 300, and the maximum is 1,000.
pageToken: Optional pagination token returned in an earlier
ListRolesResponse.
parent: The `parent` parameter's value depends on the target resource for
the request, namely
[roles](https://cloud.google.com/iam/docs/reference/rest/v1/roles), [pro
jects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.role
s), or [organizations](https://cloud.google.com/iam/docs/reference/rest/
v1/organizations.roles). Each resource type's `parent` value format is
described below: * [roles.list](https://cloud.google.com/iam/docs/refere
nce/rest/v1/roles/list): An empty string. This method doesn't require a
resource; it simply returns all [predefined
roles](https://cloud.google.com/iam/docs/understanding-
roles#predefined_roles) in IAM. Example request URL:
`https://iam.googleapis.com/v1/roles` * [projects.roles.list](https://cl
oud.google.com/iam/docs/reference/rest/v1/projects.roles/list):
`projects/{PROJECT_ID}`. This method lists all project-level [custom
roles](https://cloud.google.com/iam/docs/understanding-custom-roles).
Example request URL:
`https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [organizat
ions.roles.list](https://cloud.google.com/iam/docs/reference/rest/v1/org
anizations.roles/list): `organizations/{ORGANIZATION_ID}`. This method
lists all organization-level [custom
roles](https://cloud.google.com/iam/docs/understanding-custom-roles).
Example request URL:
`https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles`
Note: Wildcard (*) values are invalid; you must specify a complete
project ID or organization ID.
showDeleted: Include Roles that have been deleted.
view: Optional view for the returned Role objects. When `FULL` is
specified, the `includedPermissions` field is returned, which includes a
list of all permissions in the role. The default value is `BASIC`, which
does not return the `includedPermissions` field.
c \ rS rSrSrSrSrSrg)'IamRolesListRequest.ViewValueValuesEnumi r r r r Nr r r r r r r r r r r r r5 r6 r r Nr r r r r r j s{ +Z
INN
#
#Ay/@/@/F/F
G(##A&) #&&&q)+ 2A 6$r r c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
IdentityAssignmenti a Defines how to assign an identity to a workload. At least one workload
selector and at least one identity assignment method must be defined.
Fields:
allowIdentitySelfSelection: Optional. Identity assignment method that
authorizes matched workloads to self select an identity within the
parent's scope (e.g. within the namespace when the WorkloadSource is
defined on a Namespace).
singleAttributeSelectors: Optional. Workload selector that matches
workloads based on their attested attributes.
r SingleAttributeSelectorr Tr
r N) r r r r r r r allowIdentitySelfSelectionr singleAttributeSelectorsr r r r r r s1
) 5 5a 8 & 3 34Mq[_ `r r c t \ rS rSrSr " S S\R 5 r\R " S5 " S S\R 5 5 r \R " SS5 r
\R " SS 5 r\R " S
5 r\R$ " S \R& R( S 9r\R, " S
5 rSrg) InlineCertificateIssuanceConfigi a! Represents configuration for generating mutual TLS (mTLS) certificates
for the identities within this pool.
Enums:
KeyAlgorithmValueValuesEnum: Optional. Key algorithm to use when
generating the key pair. This key pair will be used to create the
certificate. If not specified, this will default to ECDSA_P256.
Messages:
CaPoolsValue: Optional. A required mapping of a Google Cloud region to the
CA pool resource located in that region. The CA pool is used for
certificate issuance, adhering to the following constraints: * Key
format: A supported cloud region name equivalent to the location
identifier in the corresponding map entry's value. * Value format: A
valid CA pool resource path format like:
"projects/{project}/locations/{location}/caPools/{ca_pool}" * Region
Matching: Workloads are ONLY issued certificates from CA pools within
the same region. Also the CA pool region (in value) must match the
workload's region (key).
Fields:
caPools: Optional. A required mapping of a Google Cloud region to the CA
pool resource located in that region. The CA pool is used for
certificate issuance, adhering to the following constraints: * Key
format: A supported cloud region name equivalent to the location
identifier in the corresponding map entry's value. * Value format: A
valid CA pool resource path format like:
"projects/{project}/locations/{location}/caPools/{ca_pool}" * Region
Matching: Workloads are ONLY issued certificates from CA pools within
the same region. Also the CA pool region (in value) must match the
workload's region (key).
keyAlgorithm: Optional. Key algorithm to use when generating the key pair.
This key pair will be used to create the certificate. If not specified,
this will default to ECDSA_P256.
lifetime: Optional. Lifetime of the workload certificates issued by the CA
pool. Must be between 24 hours and 30 days. If not specified, this will
be defaulted to 24 hours.
rotationWindowPercentage: Optional. Rotation window percentage, the
percentage of remaining lifetime after which certificate rotation is
initiated. Must be between 50 and 80. If no value is specified, rotation
window percentage is defaulted to 50.
useDefaultSharedCa: Optional. If set to true, the trust domain will
utilize the GCP-provisioned default CA. A default CA in the same region
as the workload will be selected to issue the certificate. Enabling this
will clear any existing `ca_pools` configuration to provision the
certificates. NOTE: This field is mutually exclusive with `ca_pools`. If
this flag is enabled, certificates will be automatically provisioned
from the default shared CAs. This flag should not be set if you want to
use your own CA pools to provision the certificates.
c 0 \ rS rSrSrSrSrSrSrSr Sr
S r g
) ;InlineCertificateIssuanceConfig.KeyAlgorithmValueValuesEnumi a Optional. Key algorithm to use when generating the key pair. This key
pair will be used to create the certificate. If not specified, this will
default to ECDSA_P256.
Values:
KEY_ALGORITHM_UNSPECIFIED: Unspecified key algorithm. Defaults to
ECDSA_P256.
RSA_2048: Specifies RSA with a 2048-bit modulus.
RSA_3072: Specifies RSA with a 3072-bit modulus.
RSA_4096: Specifies RSA with a 4096-bit modulus.
ECDSA_P256: Specifies ECDSA with curve P256.
ECDSA_P384: Specifies ECDSA with curve P384.
r r r r5 r6 r r N) r r r r r KEY_ALGORITHM_UNSPECIFIEDRSA_2048RSA_3072RSA_4096
ECDSA_P256
ECDSA_P384r r r r r} r s( !" HHHJJr r} additionalPropertiesc f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
,InlineCertificateIssuanceConfig.CaPoolsValuei a Optional. A required mapping of a Google Cloud region to the CA pool
resource located in that region. The CA pool is used for certificate
issuance, adhering to the following constraints: * Key format: A supported
cloud region name equivalent to the location identifier in the
corresponding map entry's value. * Value format: A valid CA pool resource
path format like:
"projects/{project}/locations/{location}/caPools/{ca_pool}" * Region
Matching: Workloads are ONLY issued certificates from CA pools within the
same region. Also the CA pool region (in value) must match the workload's
region (key).
Messages:
AdditionalProperty: An additional property for a CaPoolsValue object.
Fields:
additionalProperties: Additional properties of type CaPoolsValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)?InlineCertificateIssuanceConfig.CaPoolsValue.AdditionalPropertyi zAn additional property for a CaPoolsValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
r r r N
r r r r r r r9 r r r r r r AdditionalPropertyr )
! !! $c##A&er r r Tr
r N r r r r r r Messager r r r r r r CaPoolsValuer s2 $ 'Y . . ' %112FTXYr r r r r5 r6 r r r N)r r r r r r r7 r} r MapUnrecognizedFieldsr r r caPoolsr; r r9 lifetimer r r rotationWindowPercentager useDefaultSharedCar r r r r r s 1fINN * !!"89 ZY&& Z : Z@
" ">1 5'$$%BAF,
"
"1
%( & 3 3Ay?P?P?V?V W --a0r r c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " SS5 r Sr g) InlineTrustConfigi/ a1 Defines configuration for extending trust to additional trust domains.
By establishing trust with another domain, the current domain will recognize
and accept certificates issued by entities within the trusted domains. Note
that a trust domain automatically trusts itself, eliminating the need for
explicit configuration.
Messages:
AdditionalTrustBundlesValue: Optional. Maps specific trust domains (e.g.,
"example.com") to their corresponding TrustStore, which contain the
trusted root certificates for that domain. There can be a maximum of 10
trust domain entries in this map. Note that a trust domain automatically
trusts itself and don't need to be specified here. If however, this
WorkloadIdentityPool's trust domain contains any trust anchors in the
additional_trust_bundles map, those trust anchors will be *appended to*
the trust bundle automatically derived from your
InlineCertificateIssuanceConfig's ca_pools.
Fields:
additionalTrustBundles: Optional. Maps specific trust domains (e.g.,
"example.com") to their corresponding TrustStore, which contain the
trusted root certificates for that domain. There can be a maximum of 10
trust domain entries in this map. Note that a trust domain automatically
trusts itself and don't need to be specified here. If however, this
WorkloadIdentityPool's trust domain contains any trust anchors in the
additional_trust_bundles map, those trust anchors will be *appended to*
the trust bundle automatically derived from your
InlineCertificateIssuanceConfig's ca_pools.
r c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
-InlineTrustConfig.AdditionalTrustBundlesValueiM a Optional. Maps specific trust domains (e.g., "example.com") to their
corresponding TrustStore, which contain the trusted root certificates for
that domain. There can be a maximum of 10 trust domain entries in this
map. Note that a trust domain automatically trusts itself and don't need
to be specified here. If however, this WorkloadIdentityPool's trust domain
contains any trust anchors in the additional_trust_bundles map, those
trust anchors will be *appended to* the trust bundle automatically derived
from your InlineCertificateIssuanceConfig's ca_pools.
Messages:
AdditionalProperty: An additional property for a
AdditionalTrustBundlesValue object.
Fields:
additionalProperties: Additional properties of type
AdditionalTrustBundlesValue
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)@InlineTrustConfig.AdditionalTrustBundlesValue.AdditionalPropertyia zAn additional property for a AdditionalTrustBundlesValue object.
Fields:
key: Name of the additional property.
value: A TrustStore attribute.
r
TrustStorer r N r r r r r r r9 r r r r r r r r r a s+
! !! $c$$\15er r r Tr
r Nr r r r AdditionalTrustBundlesValuer M s2 $ 6Y . . 6 %112FTXYr r r r N)
r r r r r r r r r r r additionalTrustBundlesr r r r r r / sO : !!"89 ZI$5$5 Z : Z@ %112OQRSr r c < \ rS rSrSr\R " S5 rSrg)IntermediateCAiq zIntermediate CA certificates used for building the trust chain to trust
anchor
Fields:
pemCertificate: PEM certificate of the PKI used for validation. Must only
contain one ca certificate.
r r N r r r r r r r9 pemCertificater r r r r r q s ((+.r r c H \ rS rSrSr " S S\R 5 r " S S\R 5 r\R " S5 r
\R " SS5 r \R " S 5 r
\R " SS
5 r\R " S 5 r\R " S 5 rS
rg)KeyDatai} aO Represents a public key data along with its format.
Enums:
FormatValueValuesEnum: Output only. The format of the key.
KeySpecValueValuesEnum: Required. The specifications for the key.
Fields:
createTime: Output only. The timestamp when this key was created.
format: Output only. The format of the key.
key: Output only. The key data. The format of the key is represented by
the format field.
keySpec: Required. The specifications for the key.
notAfterTime: 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.
notBeforeTime: 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.
c \ rS rSrSrSrSrSrg) KeyData.FormatValueValuesEnumi a Output only. The format of the key.
Values:
KEY_FORMAT_UNSPECIFIED: No format has been specified. This is an invalid
format and must not be used.
RSA_X509_PEM: A RSA public key wrapped in an X.509v3 certificate
([RFC5280] ( https://www.ietf.org/rfc/rfc5280.txt)), encoded in
base64, and wrapped in [public certificate
label](https://datatracker.ietf.org/doc/html/rfc7468#section-5.1).
r r r N)r r r r r KEY_FORMAT_UNSPECIFIED RSA_X509_PEMr r r r FormatValueValuesEnumr
s Lr r c ( \ rS rSrSrSrSrSrSrSr g) KeyData.KeySpecValueValuesEnumi zRequired. The specifications for the key.
Values:
KEY_SPEC_UNSPECIFIED: No key specification specified.
RSA_2048: A 2048 bit RSA key.
RSA_3072: A 3072 bit RSA key.
RSA_4096: A 4096 bit RSA key.
r r r r5 r N)
r r r r r KEY_SPEC_UNSPECIFIEDr r r r r r r KeySpecValueValuesEnumr s HHHr r r r r5 r6 r r N)r r r r r r r7 r r r9
createTimer; formatr keySpec notAfterTime
notBeforeTimer r r r r r } s ( inn y~~ $$Q'* 6 :& a # 8! <'&&q),''*-r r c b \ rS rSrSr\R " SS5 r\R " S5 r Sr
g)LintPolicyRequesti a The request to lint an IAM policy object.
Fields:
condition: google.iam.v1.Binding.condition object to be linted.
fullResourceName: The full resource name of the policy this lint request
is about. The name follows the Google Cloud format for full resource
names. For example, a Google Cloud project with ID `my-project` will be
named `//cloudresourcemanager.googleapis.com/projects/my-project`. The
resource name is not used to read a policy from IAM. Only the data in
the request object is linted.
rc r r r N) r r r r r r r rd r9 fullResourceNamer r r r r r s,
$$VQ/) **1-r r c < \ rS rSrSr\R " SSSS9rSrg) LintPolicyResponsei zThe response of a lint operation. An empty response indicates the
operation was able to fully execute and no lint issue was found.
Fields:
lintResults: List of lint results sorted by `severity` in descending
order.
LintResultr Tr
r N) r r r r r r r lintResultsr r r r r r s &&|QF+r r c n \ rS rSrSr " S S\R 5 r " S S\R 5 r\R " S5 r
\R " S5 r \R " SS 5 r
\R " S
\R R S 9r\R " SS 5 r\R " S
5 rSrg)r i a Structured response of a single validation unit.
Enums:
LevelValueValuesEnum: The validation unit level.
SeverityValueValuesEnum: The validation unit severity.
Fields:
debugMessage: Human readable debug message associated with the issue.
fieldName: The name of the field for which this lint result is about. For
nested messages `field_name` consists of names of the embedded fields
separated by period character. The top-level qualifier is the input
object to lint in the request. For example, the `field_name` value
`condition.expression` identifies a lint result for the `expression`
field of the provided condition.
level: The validation unit level.
locationOffset: 0-based character position of problematic construct within
the object identified by `field_name`. Currently, this is populated only
for condition expression.
severity: The validation unit severity.
validationUnitName: The validation unit name, for instance
"lintValidationUnits/ConditionComplexityCheck".
c \ rS rSrSrSrSrSrg) LintResult.LevelValueValuesEnumi zThe validation unit level.
Values:
LEVEL_UNSPECIFIED: Level is unspecified.
CONDITION: A validation unit which operates on an individual condition
within a binding.
r r r N)r r r r r LEVEL_UNSPECIFIED CONDITIONr r r r LevelValueValuesEnumr$ s Ir r' c 0 \ rS rSrSrSrSrSrSrSr Sr
S r g
) "LintResult.SeverityValueValuesEnumi a The validation unit severity.
Values:
SEVERITY_UNSPECIFIED: Severity is unspecified.
ERROR: A validation unit returns an error only for critical issues. If
an attempt is made to set the problematic policy without rectifying
the critical issue, it causes the `setPolicy` operation to fail.
WARNING: Any issue which is severe enough but does not cause an error.
For example, suspicious constructs in the input object will not
necessarily fail `setPolicy`, but there is a high likelihood that they
won't behave as expected during policy evaluation in `checkPolicy`.
This includes the following common scenarios: - Unsatisfiable
condition: Expired timestamp in date/time condition. - Ineffective
condition: Condition on a pair which is granted unconditionally in
another binding of the same policy.
NOTICE: Reserved for the issues that are not severe as
`ERROR`/`WARNING`, but need special handling. For instance, messages
about skipped validation units are issued as `NOTICE`.
INFO: Any informative statement which is not severe enough to raise
`ERROR`/`WARNING`/`NOTICE`, like auto-correction recommendations on
the input content. Note that current version of the linter does not
utilize `INFO`.
DEPRECATED: Deprecated severity level.
r r r r5 r6 r r N) r r r r r SEVERITY_UNSPECIFIEDERRORWARNINGNOTICEINFO
DEPRECATEDr r r r SeverityValueValuesEnumr) s( 0
EG
F DJr r0 r r r5 r6 r r r r N)r r r r r r r7 r' r0 r9 debugMessage fieldNamer; levelr r r locationOffsetseverityvalidationUnitNamer r r r r r s . Y^^ @ &&q),##A&)
4a
8% ))!Y5F5F5L5LM.
!:A
>( ,,Q/r r c ` \ rS rSrSr\R " SSSS9r\R " S5 r Sr
g )
ListAttestationRulesResponsei a Response message for ListAttestationRules.
Fields:
attestationRules: A list of AttestationRules.
nextPageToken: Optional. A token, which can be sent as `page_token` to
retrieve the next page. If this field is omitted, there are no
subsequent pages.
r! r Tr
r r N) r r r r r r r attestationRulesr9
nextPageTokenr r r r r8 r8 s/ ++,=q4P''*-r r8 c < \ rS rSrSr\R " SSSS9rSrg) "ListOauthClientCredentialsResponsei, zvResponse message for ListOauthClientCredentials.
Fields:
oauthClientCredentials: A list of OauthClientCredentials.
r r Tr
r N) r r r r r r r oauthClientCredentialsr r r r r< r< , s %112I1W[\r r< c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
ListOauthClientsResponsei6 zResponse message for ListOauthClients.
Fields:
nextPageToken: Optional. A token, which can be sent as `page_token` to
retrieve the next page. If this field is omitted, there are no
subsequent pages.
oauthClients: A list of OauthClients.
r r r Tr
r N) r r r r r r r9 r: r oauthClientsr r r r r? r? 6 s- ''*-''
q4H,r r? c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
ListRolesResponseiD zThe response containing the roles defined under a resource.
Fields:
nextPageToken: To retrieve the next page of results, set
`ListRolesRequest.page_token` to this value.
roles: The Roles defined on this resource.
r rs r Tr
r N r r r r r r r9 r: r rolesr r r r rB rB D - ''*-
T
:%r rB c < \ rS rSrSr\R " SSSS9rSrg) ListServiceAccountKeysResponseiQ zbThe service account keys list response.
Fields:
keys: The public keys for the service account.
ServiceAccountKeyr Tr
r N) r r r r r r r keysr r r r rG rG Q s
3Q F$r rG c ` \ rS rSrSr\R " SSSS9r\R " S5 r Sr
g )
ListServiceAccountsResponsei[ zThe service account list response.
Fields:
accounts: The list of matching service accounts.
nextPageToken: To retrieve the next page of results, set
ListServiceAccountsRequest.page_token to this value.
r r Tr
r r N) r r r r r r r accountsr9 r: r r r r rK rK [ s.
#
#$4a$
G(''*-r rK c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
&ListWorkforcePoolInstalledAppsResponseih a8 Response message for ListWorkforcePoolInstalledApps.
Fields:
nextPageToken: Optional. A token, which can be sent as `page_token` to
retrieve the next page. If this field is omitted, there are no
subsequent pages.
workforcePoolInstalledApps: Output only. A list of workforce pool
installed apps.
r r r Tr
r N) r r r r r r r9 r: r workforcePoolInstalledAppsr r r r rN rN h s1 ''*- ( 5 56QST_c d r rN c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
%ListWorkforcePoolProviderKeysResponseiw a Response message for ListWorkforcePoolProviderKeys.
Fields:
nextPageToken: A token, which can be sent as `page_token` to retrieve the
next page. If this field is omitted, there are no subsequent pages.
workforcePoolProviderKeys: A list of WorkforcePoolProviderKeys.
r r, r Tr
r N) r r r r r r r9 r: r workforcePoolProviderKeysr r r r rQ rQ w s1 ''*- ' 4 45OQR]a br rQ c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
,ListWorkforcePoolProviderScimTenantsResponsei af Agentspace only. Response message for
ListWorkforcePoolProviderScimTenants.
Fields:
nextPageToken: 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.
r rE r Tr
r N) r r r r r r r9 r: r workforcePoolProviderScimTenantsr r r r rT rT s1 ''*-%.%;%;<]_`ko%p"r rT c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
+ListWorkforcePoolProviderScimTokensResponsei ac Agentspace only. Response message for
ListWorkforcePoolProviderScimTokens.
Fields:
nextPageToken: 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.
workforcePoolProviderScimTokens: Output only. Agentspace only. A list of
SCIM tokens.
r rS r Tr
r N) r r r r r r r9 r: r workforcePoolProviderScimTokensr r r r rW rW s1 ''*-$-$:$:;[]^im$n!r rW c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
"ListWorkforcePoolProvidersResponsei zResponse message for ListWorkforcePoolProviders.
Fields:
nextPageToken: A token, which can be sent as `page_token` to retrieve the
next page. If this field is omitted, there are no subsequent pages.
workforcePoolProviders: A list of providers.
r r# r Tr
r N) r r r r r r r9 r: r workforcePoolProvidersr r r r rZ rZ s0 ''*-$112I1W[\r rZ c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
ListWorkforcePoolsResponsei zResponse message for ListWorkforcePools.
Fields:
nextPageToken: A token, which can be sent as `page_token` to retrieve the
next page. If this field is omitted, there are no subsequent pages.
workforcePools: A list of pools.
r r r Tr
r N) r r r r r r r9 r: r workforcePoolsr r r r r] r] s- ''*- ))/1tL.r r] c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
1ListWorkloadIdentityPoolManagedIdentitiesResponsei a$ Response message for ListWorkloadIdentityPoolManagedIdentities.
Fields:
nextPageToken: A token, which can be sent as `page_token` to retrieve the
next page. If this field is omitted, there are no subsequent pages.
workloadIdentityPoolManagedIdentities: A list of managed identities.
r r r Tr
r N) r r r r r r r9 r: r %workloadIdentityPoolManagedIdentitiesr r r r r` r` s1 ''*-*3*@*@Afhitx*y'r r` c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
*ListWorkloadIdentityPoolNamespacesResponsei a Response message for ListWorkloadIdentityPoolNamespaces.
Fields:
nextPageToken: A token, which can be sent as `page_token` to retrieve the
next page. If this field is omitted, there are no subsequent pages.
workloadIdentityPoolNamespaces: A list of namespaces.
r r r Tr
r N) r r r r r r r9 r: r workloadIdentityPoolNamespacesr r r r rc rc s1 ''*-#,#9#9:Y[\gk#l r rc c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
,ListWorkloadIdentityPoolProviderKeysResponsei a* Response message for ListWorkloadIdentityPoolProviderKeys.
Fields:
nextPageToken: A token, which can be sent as `page_token` to retrieve the
next page. If this field is omitted, there are no subsequent pages.
workloadIdentityPoolProviderKeys: A list of
WorkloadIdentityPoolProviderKey
r r[ r Tr
r N) r r r r r r r9 r: r workloadIdentityPoolProviderKeysr r r r rf rf s1 ''*-%.%;%;<]_`ko%p"r rf c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
)ListWorkloadIdentityPoolProvidersResponsei a Response message for ListWorkloadIdentityPoolProviders.
Fields:
nextPageToken: A token, which can be sent as `page_token` to retrieve the
next page. If this field is omitted, there are no subsequent pages.
workloadIdentityPoolProviders: A list of providers.
r rR r Tr
r N) r r r r r r r9 r: r workloadIdentityPoolProvidersr r r r ri ri s1 ''*-"+"8"89WYZei"j r ri c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
!ListWorkloadIdentityPoolsResponsei zResponse message for ListWorkloadIdentityPools.
Fields:
nextPageToken: A token, which can be sent as `page_token` to retrieve the
next page. If this field is omitted, there are no subsequent pages.
workloadIdentityPools: A list of pools.
r r r Tr
r N) r r r r r r r9 r: r workloadIdentityPoolsr r r r rl rl s0 ''*-#001GUYZr rl c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
ListWorkloadSourcesResponsei zResponse message for ListWorkloadSources.
Fields:
nextPageToken: A token, which can be sent as `page_token` to retrieve the
next page. If this field is omitted, there are no subsequent pages.
workloadSources: A list of workload sources.
r r r Tr
r N) r r r r r r r9 r: r workloadSourcesr r r r ro ro s. ''*- **+;QN/r ro c F \ rS rSrSr " S S\R 5 r " S S\R 5 r " S S\R 5 r \R " SS S
S 9r \R " S S
S 9r
\R " S
S
S 9r\R " S5 r\R " SS5 r\R " S5 r\R$ " S5 r\R " S5 r\R " S5 r\R " S5 r\R$ " S5 r\R " SS5 rSrg)r i
ab 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.
Enums:
AllowedGrantTypesValueListEntryValuesEnum:
ClientTypeValueValuesEnum: Immutable. The type of OauthClient. Either
public or private. For private clients, the client secret can be managed
using the dedicated OauthClientCredential resource.
StateValueValuesEnum: Output only. The state of the OauthClient.
Fields:
allowedGrantTypes: Required. The list of OAuth grant types is allowed for
the OauthClient.
allowedRedirectUris: Required. The list of redirect uris that is allowed
to redirect back when authorization process is completed.
allowedScopes: Required. The list of scopes that the OauthClient is
allowed to request during OAuth flows. The following scopes are
supported: * `https://www.googleapis.com/auth/cloud-platform`: See,
edit, configure, and delete your Google Cloud data and see the email
address for your Google Account. * `openid`: The OAuth client can
associate you with your personal information on Google Cloud. * `email`:
The OAuth client can read a federated identity's email address. *
`groups`: The OAuth client can read a federated identity's groups.
clientId: Output only. The system-generated OauthClient id.
clientType: Immutable. The type of OauthClient. Either public or private.
For private clients, the client secret can be managed using the
dedicated OauthClientCredential resource.
description: Optional. A user-specified description of the OauthClient.
Cannot exceed 256 characters.
disabled: Optional. Whether the OauthClient is disabled. You cannot use a
disabled OAuth client.
displayName: Optional. A user-specified display name of the OauthClient.
Cannot exceed 32 characters.
expireTime: Output only. Time after which the OauthClient will be
permanently purged and cannot be recovered.
name: Immutable. Identifier. The resource name of the OauthClient. Format:
`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.
pkceEnforced: Optional. Indicates whether to enforce PKCE (RFC 7636) for
the OauthClient. If not set, the default value is false. Public clients
must set this field to true.
state: Output only. The state of the OauthClient.
c $ \ rS rSrSrSrSrSrSrg)5OauthClient.AllowedGrantTypesValueListEntryValuesEnumi: zAllowedGrantTypesValueListEntryValuesEnum enum type.
Values:
GRANT_TYPE_UNSPECIFIED: Should not be used.
AUTHORIZATION_CODE_GRANT: Authorization code grant.
REFRESH_TOKEN_GRANT: Refresh token grant.
r r r r N) r r r r r GRANT_TYPE_UNSPECIFIEDAUTHORIZATION_CODE_GRANTREFRESH_TOKEN_GRANTr r r r )AllowedGrantTypesValueListEntryValuesEnumrs : s r rw c $ \ rS rSrSrSrSrSrSrg)%OauthClient.ClientTypeValueValuesEnumiF a5 Immutable. The type of OauthClient. Either public or private. For
private clients, the client secret can be managed using the dedicated
OauthClientCredential resource.
Values:
CLIENT_TYPE_UNSPECIFIED: Should not be used.
PUBLIC_CLIENT: Public client has no secret.
CONFIDENTIAL_CLIENT: Private client.
r r r r N) r r r r r CLIENT_TYPE_UNSPECIFIED
PUBLIC_CLIENTCONFIDENTIAL_CLIENTr r r r ClientTypeValueValuesEnumry F s Mr r} c $ \ rS rSrSrSrSrSrSrg) OauthClient.StateValueValuesEnumiT a> Output only. The state of the OauthClient.
Values:
STATE_UNSPECIFIED: Default value. This value is unused.
ACTIVE: The OauthClient is active.
DELETED: The OauthClient is soft-deleted. Soft-deleted OauthClient is
permanently deleted after approximately 30 days unless restored via
`UndeleteOauthClient`.
r r r r Nr0 r r r r4 r T
FGr r4 r Tr
r r5 r6 r r
r N)r r r r r r r7 rw r} r4 r; allowedGrantTypesr9 allowedRedirectUris
allowedScopesr
clientTyper r r8 displayName
expireTimer: pkceEnforcedr< r r r r r r
s
*X
)..
).. Y^^ ))*UWXcgh!--a$?''D9-
"
"1
%(""#>B*%%a(+
#
#A
&(%%a(+$$Q'* r "$''+,
4b
9%r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r
\R " S5 r \R " S5 r \R " S5 r
S rg
) r ip a Represents an OauthClientCredential. Used to authenticate an OauthClient
while accessing Google Cloud resources on behalf of a user by using OAuth
2.0 Protocol.
Fields:
clientSecret: Output only. The system-generated OAuth client secret. The
client secret must be stored securely. If the client secret is leaked,
you must delete and re-create the client credential. To learn more, see
[OAuth client and credential security risks and
mitigations](https://cloud.google.com/iam/docs/workforce-oauth-
app#security)
createTime: Output only. The timestamp when the OauthClientCredential was
created.
disabled: Optional. Whether the OauthClientCredential is disabled. You
cannot use a disabled OauthClientCredential.
displayName: Optional. A user-specified display name of the
OauthClientCredential. Cannot exceed 32 characters.
name: Immutable. Identifier. The resource name of the
OauthClientCredential. Format: `projects/{project}/locations/{location}/
oauthClients/{oauth_client}/credentials/{credential}`
updateTime: Output only. The timestamp for the last update of the
OauthClientCredential. If no updates have been made, the creation time
will serve as the designated value.
r r r5 r6 r r r N)r r r r r r r9 r r r r8 r r:
updateTimer r r r r r p si 2 &&q),$$Q'*
#
#A
&(%%a(+ q !$$$Q'*r r c \ rS rSrSr\R " SSS9r\R " S5 r\R " S5 r Sr
g )
Oidci a Represents an OpenId Connect 1.0 identity provider.
Fields:
allowedAudiences: Optional. Acceptable values for the `aud` field
(audience) in the OIDC token. Token exchange requests are rejected if
the token audience does not match one of the configured values. Each
audience may be at most 256 characters. A maximum of 10 audiences may be
configured. If this list is empty, the OIDC token audience must be equal
to the full canonical resource name of the WorkloadIdentityPoolProvider,
with or without the HTTPS prefix. For example: ``` //iam.googleapis.com/
projects//locations//workloadIdentityPools//providers/ https://iam.googl
eapis.com/projects//locations//workloadIdentityPools//providers/ ```
issuerUri: Required. The OIDC issuer URL. Must be an HTTPS endpoint. Per
OpenID Connect Discovery 1.0 spec, the OIDC issuer URL is used to locate
the provider's public keys (via `jwks_uri`) for verifying tokens like
the OIDC ID token. These public key types must be 'EC' or 'RSA'.
jwksJson: Optional. OIDC JWKs in JSON String format. For details on the
definition of a JWK, see https://tools.ietf.org/html/rfc7517. If not
set, the `jwks_uri` from the discovery document(fetched from the .well-
known path of the `issuer_uri`) will be used. Currently, RSA and EC
asymmetric keys are supported. The JWK must use following format and
include only the following fields: { "keys": [ { "kty": "RSA/EC", "alg":
"", "use": "sig", "kid": "", "n": "", "e": "", "x": "", "y": "", "crv":
"" } ] }
r Tr
r r5 r N) r r r r r r r9 allowedAudiencesr r r r r r r r s< 4 **1t<##A&)
"
"1
%(r r c z \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 " S S\R 5 5 r
\R " S5 r \R " S S
5 r\R " SS 5 r\R " S 5 r\R " SS
5 rSrg) Operationi a This resource represents a long-running operation that is the result of
a network API call.
Messages:
MetadataValue: Service-specific metadata associated with the operation. It
typically contains progress information and common metadata such as
create time. Some services might not provide such metadata. Any method
that returns a long-running operation should document the metadata type,
if any.
ResponseValue: The normal, successful response of the operation. If the
original method returns no data on success, such as `Delete`, the
response is `google.protobuf.Empty`. If the original method is standard
`Get`/`Create`/`Update`, the response should be the resource. For other
methods, the response should have the type `XxxResponse`, where `Xxx` is
the original method name. For example, if the original method name is
`TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
Fields:
done: If the value is `false`, it means the operation is still in
progress. If `true`, the operation is completed, and either `error` or
`response` is available.
error: The error result of the operation in case of failure or
cancellation.
metadata: Service-specific metadata associated with the operation. It
typically contains progress information and common metadata such as
create time. Some services might not provide such metadata. Any method
that returns a long-running operation should document the metadata type,
if any.
name: The server-assigned name, which is only unique within the same
service that originally returns it. If you use the default HTTP mapping,
the `name` should be a resource name ending with
`operations/{unique_id}`.
response: The normal, successful response of the operation. If the
original method returns no data on success, such as `Delete`, the
response is `google.protobuf.Empty`. If the original method is standard
`Get`/`Create`/`Update`, the response should be the resource. For other
methods, the response should have the type `XxxResponse`, where `Xxx` is
the original method name. For example, if the original method name is
`TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
r c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Operation.MetadataValuei a Service-specific metadata associated with the operation. It typically
contains progress information and common metadata such as create time.
Some services might not provide such metadata. Any method that returns a
long-running operation should document the metadata type, if any.
Messages:
AdditionalProperty: An additional property for a MetadataValue object.
Fields:
additionalProperties: Properties of the object. Contains field @type
with type URL.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)*Operation.MetadataValue.AdditionalPropertyi zAn additional property for a MetadataValue object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r extra_types.JsonValuer r Nr r r r r r ,
! !! $c$$%.$$Q'*r r c \ rS rSrSr " S S\R 5 r " S S\R 5 r\R " S5 r
\R " SS5 r \R " S 5 r\R " S
5 r\R " S 5 r\R " S 5 r\R " SS
5 r\R " S5 rSrg)
PermissioniS a A permission which can be included by a role.
Enums:
CustomRolesSupportLevelValueValuesEnum: The current custom role support
level.
StageValueValuesEnum: The current launch stage of the permission.
Fields:
apiDisabled: The service API associated with the permission is not
enabled.
customRolesSupportLevel: The current custom role support level.
description: A brief description of what this Permission is used for.
name: The name of this Permission.
onlyInPredefinedRoles: A boolean attribute.
primaryPermission: The preferred name for this permission. If present,
then this permission is an alias of, and equivalent to, the listed
primary_permission.
stage: The current launch stage of the permission.
title: The title of this Permission.
c $ \ rS rSrSrSrSrSrSrg)1Permission.CustomRolesSupportLevelValueValuesEnumii a The current custom role support level.
Values:
SUPPORTED: Default state. Permission is fully supported for custom role
use.
TESTING: Permission is being tested to check custom role compatibility.
NOT_SUPPORTED: Permission is not supported for custom role use.
r r r r N) r r r r r SUPPORTEDTESTING
NOT_SUPPORTEDr r r r &CustomRolesSupportLevelValueValuesEnumr i s IGMr r c ( \ rS rSrSrSrSrSrSrSr g) Permission.StageValueValuesEnumiv a The current launch stage of the permission.
Values:
ALPHA: The permission is currently in an alpha phase.
BETA: The permission is currently in a beta phase.
GA: The permission is generally available.
DEPRECATED: The permission is being deprecated.
r r r r5 r N)
r r r r r ALPHABETAGAr/ r r r r StageValueValuesEnumr v s
E D
BJr r r r r5 r6 r r r r r N)r r r r r r r7 r r r apiDisabledr; customRolesSupportLevelr9 r r: onlyInPredefinedRolesprimaryPermissionstager r r r r r r S s * y~~ Y^^ &&q)+ % / /0XZ[ \%%a(+ q !$#003 ++A.
4a
8%
"%r r c \ \ rS rSrSr\R " SSS9r\R " SSS9rSr g) r( i zA PermissionDelta message to record the added_permissions and
removed_permissions inside a role.
Fields:
addedPermissions: Added permissions.
removedPermissions: Removed permissions.
r Tr
r r N)
r r r r r r r9 addedPermissionsremovedPermissionsr r r r r( r( s/ **1t< ,,Q>r r( c \ rS rSrSr\R " SSSS9r\R " SSSS9r\R " S 5 r
\R " S
\R R S 9rS rg
)Policyi aw 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](https://cloud.google.com/iam/help/conditions/resource-
policies). **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](https://cloud.google.com/iam/docs/).
Fields:
auditConfigs: Specifies cloud audit logging configuration for this policy.
bindings: Associates a list of `members`, or principals, with a `role`.
Optionally, may specify a `condition` that determines how and when the
`bindings` are applied. Each of the `bindings` must contain at least one
principal. The `bindings` in a `Policy` can refer to up to 1,500
principals; up to 250 of these principals can be Google groups. Each
occurrence of a principal counts towards these limits. For example, if
the `bindings` grant 50 different roles to `user:alice@example.com`, and
not to any other principal, then you can add another 1,450 principals to
the `bindings` in the `Policy`.
etag: `etag` is used for optimistic concurrency control as a way to help
prevent simultaneous updates of a policy from overwriting each other. It
is strongly suggested that systems make use of the `etag` in the read-
modify-write cycle to perform policy updates in order to avoid race
conditions: An `etag` is returned in the response to `getIamPolicy`, and
systems are expected to put that etag in the request to `setIamPolicy`
to ensure that their change will be applied to the same version of the
policy. **Important:** If you use IAM Conditions, you must include the
`etag` field whenever you call `setIamPolicy`. If you omit this field,
then IAM allows you to overwrite a version `3` policy with a version `1`
policy, and all of the conditions in the version `3` policy are lost.
version: Specifies the format of the policy. Valid values are `0`, `1`,
and `3`. Requests that specify an invalid value are rejected. Any
operation that affects conditional role bindings must specify version
`3`. This requirement applies to the following operations: * Getting a
policy that includes a conditional role binding * Adding a conditional
role binding to a policy * Changing a conditional role binding in a
policy * Removing any role binding, with or without a condition, from a
policy that includes conditions **Important:** If you use IAM
Conditions, you must include the `etag` field whenever you call
`setIamPolicy`. If you omit this field, then IAM allows you to overwrite
a version `3` policy with a version `1` policy, and all of the
conditions in the version `3` policy are lost. If a policy does not
include any conditions, operations on that policy may specify any valid
version or leave the field unset. To learn which resources support
conditions in their IAM policies, see the [IAM
documentation](https://cloud.google.com/iam/help/conditions/resource-
policies).
rB r Tr
ra r r5 r6 r r N)r r r r r r r auditConfigsbindingsr r r r r versionr r r r r r sa EN ''
q4H,
#
#Iq4
@( a $ " "1i.?.?.E.E F'r r c < \ rS rSrSr\R " SSSS9rSrg) rJ i zrThe difference delta between two policies.
Fields:
bindingDeltas: The delta for Bindings between two policies.
rh r Tr
r N) r r r r r r r
bindingDeltasr r r r rJ rJ s (( TJ-r rJ c < \ rS rSrSr\R " S5 rSrg) QueryAuditableServicesRequesti a A request to get the list of auditable services for a resource.
Fields:
fullResourceName: Required. The full resource name to query from the list
of auditable services. The name follows the Google Cloud Platform
resource format. For example, a Cloud Platform project with id `my-
project` will be named
`//cloudresourcemanager.googleapis.com/projects/my-project`.
r r N) r r r r r r r9 r r r r r r r s **1-r r c < \ rS rSrSr\R " SSSS9rSrg) QueryAuditableServicesResponsei zA response containing a list of auditable services for a resource.
Fields:
services: The auditable services for a resource.
rY r Tr
r N) r r r r r r r servicesr r r r r r s
#
#$6D
I(r r c \ rS rSrSr " S S\R 5 r\R " S5 r \R " S\R R S9r
\R " S5 r\R " SS 5 rS
rg ) QueryGrantableRolesRequesti a The grantable role query request.
Enums:
ViewValueValuesEnum:
Fields:
fullResourceName: Required. Required. The full resource name to query from
the list of grantable roles. The name follows the Google Cloud Platform
resource format. For example, a Cloud Platform project with id `my-
project` will be named
`//cloudresourcemanager.googleapis.com/projects/my-project`.
pageSize: Optional limit on the number of roles to include in the
response. The default is 300, and the maximum is 2,000.
pageToken: Optional pagination token returned in an earlier
QueryGrantableRolesResponse.
view: A ViewValueValuesEnum attribute.
c \ rS rSrSrSrSrSrg).QueryGrantableRolesRequest.ViewValueValuesEnumi zViewValueValuesEnum enum type.
Values:
BASIC: Omits the `included_permissions` field. This is the default
value.
FULL: Returns all fields.
r r r Nr r r r r r s
E Dr r r r r r5 r6 r N)r r r r r r r7 r r9 r r r r r r r; r r r r r r r sk $
INN
**1-
#
#Ay/@/@/F/F
G(##A&) 2A 6$r r c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
QueryGrantableRolesResponsei/ zThe grantable role query response.
Fields:
nextPageToken: To retrieve the next page of results, set
`QueryGrantableRolesRequest.page_token` to this value.
roles: The list of matching roles.
r rs r Tr
r NrC r r r r r / rE r r c \ rS rSrSr\R " S5 r\R " S\R R S9r \R " S5 r Sr
g) QueryTestablePermissionsRequesti< aj A request to get permissions which can be tested on a resource.
Fields:
fullResourceName: Required. The full resource name to query from the list
of testable permissions. The name follows the Google Cloud Platform
resource format. For example, a Cloud Platform project with id `my-
project` will be named
`//cloudresourcemanager.googleapis.com/projects/my-project`.
pageSize: Optional limit on the number of permissions to include in the
response. The default is 100, and the maximum is 1,000.
pageToken: Optional pagination token returned in an earlier
QueryTestablePermissionsRequest.
r r r r5 r N)r r r r r r r9 r r r r r r r r r r r r < sH **1-
#
#Ay/@/@/F/F
G(##A&)r r c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
QueryTestablePermissionsResponseiP a The response containing permissions which can be tested on a resource.
Fields:
nextPageToken: To retrieve the next page of results, set
`QueryTestableRolesRequest.page_token` to this value.
permissions: The Permissions testable on the requested resource.
r r r Tr
r N) r r r r r r r9 r: r permissionsr r r r r r P s- ''*-&&|QF+r r c \ rS rSrSr " S S\R 5 r\R " S5 r \R " SS5 r Sr g) ReconciliationOperationMetadatai] a Operation metadata returned by the CLH during resource state
reconciliation.
Enums:
ExclusiveActionValueValuesEnum: Excluisive action returned by the CLH.
Fields:
deleteResource: DEPRECATED. Use exclusive_action instead.
exclusiveAction: Excluisive action returned by the CLH.
c $ \ rS rSrSrSrSrSrSrg)>ReconciliationOperationMetadata.ExclusiveActionValueValuesEnumii a Excluisive action returned by the CLH.
Values:
UNKNOWN_REPAIR_ACTION: Unknown repair action.
DELETE: The resource has to be deleted. When using this bit, the CLH
should fail the operation. DEPRECATED. Instead use DELETE_RESOURCE
OperationSignal in SideChannel.
RETRY: This resource could not be repaired but the repair should be
tried again at a later time. This can happen if there is a dependency
that needs to be resolved first- e.g. if a parent resource must be
repaired before a child resource.
r r r r N) r r r r r UNKNOWN_REPAIR_ACTIONDELETERETRYr r r r ExclusiveActionValueValuesEnumr i s
F
Er r r r r N)
r r r r r r r7 r r deleteResourcer; exclusiveActionr r r r r r ] s< y~~ " ))!,. ''(H!L/r r c > \ rS rSrSr\R " SS5 rSrg)r i~ zuRequest message for RemoveAttestationRule.
Fields:
attestationRule: Required. The attestation rule to be removed.
r! r r Nr" r r r r r ~ r$ r r c > \ rS rSrSr " S S\R 5 r\R " S5 r \R " S5 r \R " S5 r
\R " SS S
9r\R " S 5 r\R " SS 5 r\R " S
5 rSrg)rs i ab A role in the Identity and Access Management API.
Enums:
StageValueValuesEnum: 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.
Fields:
deleted: The current deleted state of the role. This field is read only.
It will be ignored in calls to CreateRole and UpdateRole.
description: Optional. A human-readable description for the role.
etag: Used to perform a consistent read-modify-write.
includedPermissions: The names of the permissions this role grants when
bound in an IAM policy.
name: The name of the role. When `Role` is used in `CreateRole`, the role
name must not be set. When `Role` is used in output and other input such
as `UpdateRole`, the role name is the complete path. For example,
`roles/logging.viewer` for predefined roles,
`organizations/{ORGANIZATION_ID}/roles/myRole` for organization-level
custom roles, and `projects/{PROJECT_ID}/roles/myRole` for project-level
custom roles.
stage: 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.
title: Optional. A human-readable title for the role. Typically this is
limited to 100 UTF-8 bytes.
c 0 \ rS rSrSrSrSrSrSrSr Sr
S r g
) Role.StageValueValuesEnumi a 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.
Values:
ALPHA: The user has indicated this role is currently in an Alpha phase.
If this launch stage is selected, the `stage` field will not be
included when requesting the definition for a given role.
BETA: The user has indicated this role is currently in a Beta phase.
GA: The user has indicated this role is generally available.
DEPRECATED: The user has indicated this role is being deprecated.
DISABLED: This role is disabled and will not contribute permissions to
any principals it is granted to in policies.
EAP: The user has indicated this role is currently in an EAP phase.
r r r r5 r6 r r N) r r r r r r r r r/ DISABLEDEAPr r r r r r s'
E D
BJH
Cr r r r r5 r6 Tr
r r r r N)r r r r r r r7 r r deletedr9 r r r includedPermissionsr: r; r r r r r r rs rs s 8 Y^^ .
" "1 %'%%a(+ a $!--a$? q !$
4a
8%
"%r rs c < \ rS rSrSr\R " S5 rSrg)Samli a Represents an SAML 2.0 identity provider.
Fields:
idpMetadataXml: Required. SAML identity provider (IdP) configuration
metadata XML doc. The XML document must comply with the [SAML 2.0
specification](https://docs.oasis-open.org/security/saml/v2.0/saml-
metadata-2.0-os.pdf). The maximum size of an acceptable XML document is
128K characters. The SAML metadata XML document must satisfy the
following constraints: * Must contain an IdP Entity ID. * Must contain
at least one non-expired signing certificate. * For each signing
certificate, the expiration must be: * From no more than 7 days in the
future. * To no more than 25 years in the future. * Up to three IdP
signing keys are allowed. When updating the provider's metadata XML, at
least one non-expired signing key must overlap with the existing
metadata. This requirement is skipped if there are no non-expired
signing keys present in the existing metadata.
r r Nr r r r r r r r r c \ \ rS rSrSr\R " S5 r\R " S5 r \R " S5 r
\R " S5 r \R " S5 r
\R " S5 r\R " S 5 r\R " S
5 r\R " S 5 rS rg
)r i a 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](https://cloud.google.com/iam/help/service-
accounts/overview). 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. //
Fields:
description: Optional. A user-specified, human-readable description of the
service account. The maximum length is 256 UTF-8 bytes.
disabled: Output only. Whether the service account is disabled.
displayName: Optional. A user-specified, human-readable name for the
service account. The maximum length is 100 UTF-8 bytes.
email: Output only. The email address of the service account.
etag: Deprecated. Do not use.
name: The resource name of the service account. Use one of the following
formats: * `projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}` *
`projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}` As an alternative,
you can use the `-` wildcard character instead of the project ID: *
`projects/-/serviceAccounts/{EMAIL_ADDRESS}` *
`projects/-/serviceAccounts/{UNIQUE_ID}` When possible, avoid using the
`-` wildcard character, because it can cause response messages to
contain misleading error codes. For example, if you try to access the
service account `projects/-/serviceAccounts/fake@example.com`, which
does not exist, the response contains an HTTP `403 Forbidden` error
instead of a `404 Not Found` error.
oauth2ClientId: Output only. The OAuth 2.0 client ID for the service
account.
projectId: Output only. The ID of the project that owns the service
account.
uniqueId: Output only. The unique, stable numeric ID for the service
account. Each service account retains its unique ID even if you delete
the service account. For example, if you delete a service account, then
create a new service account with the same name, the new service account
has a different unique ID than the deleted service account.
r r r5 r6 r r r r r r N)r r r r r r r9 r r r8 r emailr r r: oauth2ClientId projectIduniqueIdr r r r r r s %N %%a(+
#
#A
&(%%a(+
"% a $ q !$ ((+.##A&)
"
"1
%(r r c \ rS rSrSr " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S
\R 5 r
" S S \R 5 r \R " SS
5 r
\R " S5 r\R " SSSS9r\R " SS5 r\R " SS5 r\R " S
S5 r\R* " S5 r\R. " S5 r\R " S S5 r\R. " S5 r\R* " S5 r\R* " S5 r S r g ) rH i a
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.
Enums:
DisableReasonValueValuesEnum: Output only. optional. If the key is
disabled, it may have a DisableReason describing why it was disabled.
KeyAlgorithmValueValuesEnum: Specifies the algorithm (and possibly key
size) for the key.
KeyOriginValueValuesEnum: The key origin.
KeyTypeValueValuesEnum: The key type.
PrivateKeyTypeValueValuesEnum: The output format for the private key. Only
provided in `CreateServiceAccountKey` responses, not in
`GetServiceAccountKey` or `ListServiceAccountKey` responses. Google
never exposes system-managed private keys, and never retains user-
managed private keys.
Fields:
disableReason: Output only. optional. If the key is disabled, it may have
a DisableReason describing why it was disabled.
disabled: The key status.
extendedStatus: Output only. Extended Status provides permanent
information about a service account key. For example, if this key was
detected as exposed or compromised, that information will remain for the
lifetime of the key in the extended_status.
keyAlgorithm: Specifies the algorithm (and possibly key size) for the key.
keyOrigin: The key origin.
keyType: The key type.
name: The resource name of the service account key in the following format
`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.
privateKeyData: The private key data. Only provided in
`CreateServiceAccountKey` responses. Make sure to keep the private key
data secure because it allows for the assertion of the service account
identity. When base64 decoded, the private key data can be used to
authenticate with Google API client libraries and with gcloud auth
activate-service-account.
privateKeyType: The output format for the private key. Only provided in
`CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or
`ListServiceAccountKey` responses. Google never exposes system-managed
private keys, and never retains user-managed private keys.
publicKeyData: The public key data. Only provided in
`GetServiceAccountKey` responses.
validAfterTime: The key can be used after this timestamp.
validBeforeTime: The key can be used before this timestamp. For system-
managed key pairs, this timestamp is the end time for the private key
signing operation. The public key could still be used for verification
for a few hours after this time.
c ( \ rS rSrSrSrSrSrSrSr g) .ServiceAccountKey.DisableReasonValueValuesEnumiL af Output only. optional. If the key is disabled, it may have a
DisableReason describing why it was disabled.
Values:
SERVICE_ACCOUNT_KEY_DISABLE_REASON_UNSPECIFIED: Unspecified disable
reason
SERVICE_ACCOUNT_KEY_DISABLE_REASON_USER_INITIATED: Disabled by the user
SERVICE_ACCOUNT_KEY_DISABLE_REASON_EXPOSED: Google detected this Service
Account external key's private key data as exposed, typically in a
public repository on GitHub or similar.
SERVICE_ACCOUNT_KEY_DISABLE_REASON_COMPROMISE_DETECTED: This service
account external key was detected as compromised and used by an
attacker.
r r r r5 r Nr r r r DisableReasonValueValuesEnumr L s!
67289512.=>:r r c $ \ rS rSrSrSrSrSrSrg)-ServiceAccountKey.KeyAlgorithmValueValuesEnumi` zSpecifies the algorithm (and possibly key size) for the key.
Values:
KEY_ALG_UNSPECIFIED: An unspecified key algorithm.
KEY_ALG_RSA_1024: 1k RSA Key.
KEY_ALG_RSA_2048: 2k RSA Key.
r r r r Nry r r r r} r ` s r r} c $ \ rS rSrSrSrSrSrSrg)*ServiceAccountKey.KeyOriginValueValuesEnumil zThe key origin.
Values:
ORIGIN_UNSPECIFIED: Unspecified key origin.
USER_PROVIDED: Key is provided by user.
GOOGLE_PROVIDED: Key is provided by Google.
r r r r N) r r r r r ORIGIN_UNSPECIFIED
USER_PROVIDEDGOOGLE_PROVIDEDr r r r KeyOriginValueValuesEnumr l s MOr r c $ \ rS rSrSrSrSrSrSrg)(ServiceAccountKey.KeyTypeValueValuesEnumix a The key type.
Values:
KEY_TYPE_UNSPECIFIED: Unspecified key type. The presence of this in the
message will immediately result in an error.
USER_MANAGED: User-managed keys (managed and rotated by the user).
SYSTEM_MANAGED: System-managed keys (managed and rotated by Google).
r r r r Nr r r r KeyTypeValueValuesEnumr x s LNr r c $ \ rS rSrSrSrSrSrSrg)/ServiceAccountKey.PrivateKeyTypeValueValuesEnumi a8 The output format for the private key. Only provided in
`CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or
`ListServiceAccountKey` responses. Google never exposes system-managed
private keys, and never retains user-managed private keys.
Values:
TYPE_UNSPECIFIED: Unspecified. Equivalent to
`TYPE_GOOGLE_CREDENTIALS_FILE`.
TYPE_PKCS12_FILE: PKCS12 format. The password for the PKCS12 file is
`notasecret`. For more information, see
https://tools.ietf.org/html/rfc7292.
TYPE_GOOGLE_CREDENTIALS_FILE: Google Credentials File format.
r r r r Nr r r r r r s #$ r r r r r r5 Tr
r6 r r r r r r r r r N) r r r r r r r7 r r} r r r r;
disableReasonr r8 r extendedStatusr keyOriginkeyTyper9 r: r privateKeyDatar
publicKeyDatavalidAfterTimevalidBeforeTimer r r r rH rH s. ;z?Y^^ ?(
INN
y~~ %inn %$ %%&DaH-
#
#A
&( ))*:AM.$$%BAF,!!"" to include in api
requests.
uploadType: Legacy upload protocol for media (e.g. "media", "multipart").
upload_protocol: Upload protocol for media (e.g. "raw", "multipart").
c $ \ rS rSrSrSrSrSrSrg)*StandardQueryParameters.AltValueValuesEnumiB zData format for response.
Values:
json: Responses with Content-Type of application/json
media: Media download with context-dependent Content-Type
proto: Responses with Content-Type of application/x-protobuf
r r r r N) r r r r r jsonmediaprotor r r r AltValueValuesEnumr& B s
D
E
Er r* c \ rS rSrSrSrSrSrg)-StandardQueryParameters.FXgafvValueValuesEnumiN zFV1 error format.
Values:
_1: v1 error format
_2: v2 error format
r r r N)r r r r r _1_2r r r r FXgafvValueValuesEnumr, N s
B
Br r/ r r r5 r' )defaultr6 r r r r Tr r r r r N)r r r r r r r7 r* r/ r; f__xgafvr9 access_tokenaltcallbackfieldsr oauth_tokenr prettyPrint quotaUsertrace
uploadTypeupload_protocolr r r r r$ r$ ' s 4
9>>
inn
!8!
<(&&q), 0!VD#
"
"1
%( #& a #%%a(+&&q$7+##A&)
#%$$R(* ))"-/r r$ c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S\R R S9r
\R " SSS S
9r\R " S 5 rS rg
)r if a 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](https://github.com/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](https://cloud.google.com/apis/design/errors).
Messages:
DetailsValueListEntry: A DetailsValueListEntry object.
Fields:
code: The status code, which should be an enum value of google.rpc.Code.
details: A list of messages that carry the error details. There is a
common set of message types for APIs to use.
message: A developer-facing error message, which should be in English. Any
user-facing error message should be localized and sent in the
google.rpc.Status.details field, or localized by the client.
r c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Status.DetailsValueListEntryiz zA DetailsValueListEntry object.
Messages:
AdditionalProperty: An additional property for a DetailsValueListEntry
object.
Fields:
additionalProperties: Properties of the object. Contains field @type
with type URL.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)/Status.DetailsValueListEntry.AdditionalPropertyi zAn additional property for a DetailsValueListEntry object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r r r r Nr r r r r r@ r r r r Tr
r Nr r r r DetailsValueListEntryr> z s4 AY . . A %112FTXYr rA r r r Tr
r5 r N)r r r r r r r r r rA r r r coder detailsr9 messager r r r r r f s| & !!"89Zi / / Z :Z2
9+<+<+B+B C$ " "#:A M' ! !! $'r r c : \ rS rSrSr\R " SSS9rSrg)rz i a3 Request message for `TestIamPermissions` method.
Fields:
permissions: The set of permissions to check for the `resource`.
Permissions with wildcards (such as `*` or `storage.*`) are not allowed.
For more information see [IAM
Overview](https://cloud.google.com/iam/docs/overview#permissions).
r Tr
r N r r r r r r r9 r r r r r rz rz s %%a$7+r rz c : \ rS rSrSr\R " SSS9rSrg)TestIamPermissionsResponsei zResponse message for `TestIamPermissions` method.
Fields:
permissions: A subset of `TestPermissionsRequest.permissions` that the
caller is allowed.
r Tr
r NrF r r r rH rH s %%a$7+r rH c < \ rS rSrSr\R " S5 rSrg) TrustAnchori zRepresents a root of trust.
Fields:
pemCertificate: PEM certificate of the PKI used for validation. Must only
contain one ca certificate(either root or intermediate cert).
r r Nr r r r rJ rJ s ((+.r rJ c \ rS rSrSr\R " SSSS9r\R " SSSS9r\R " S 5 r
S
r g ) r i aH Trust store that contains trust anchors and optional intermediate CAs
used in PKI to build a trust chain(trust hierarchy) and verify a client's
identity.
Fields:
intermediateCas: Optional. Set of intermediate CA certificates used for
building the trust chain to the trust anchor. Important: Intermediate
CAs are only supported for X.509 federation.
trustAnchors: Required. List of trust anchors to be used while performing
validation against a given TrustStore. The incoming end entity's
certificate must be in the trust chain of one of the trust anchors here.
trustDefaultSharedCa: Optional. If set to True, the trust bundle will
include the private ca managed identity regional root public
certificates. Important: `trust_default_shared_ca` is only supported for
managed identity trust domain resource.
r r Tr
rJ r r5 r N) r r r r r r r intermediateCas trustAnchorsr trustDefaultSharedCar r r r r r sC " **+;QN/''
q4H,"//2r r c < \ rS rSrSr\R " S5 rSrg)r i zRequest message for UndeleteOauthClient.
Fields:
validateOnly: Optional. If set, validate the request and preview the
response, but do not actually post it.
r r N r r r r r r r r r r r r r r ''*,r r c < \ rS rSrSr\R " S5 rSrg)r i zkThe request to undelete an existing role.
Fields:
etag: Used to perform a consistent read-modify-write.
r r N) r r r r r r r r r r r r r r s
a $r r c \ rS rSrSrSrg)r i z%The service account undelete request.r Nr r r r r r s .r r c > \ rS rSrSr\R " SS5 rSrg) UndeleteServiceAccountResponsei zpA UndeleteServiceAccountResponse object.
Fields:
restoredAccount: Metadata for the restored service account.
r r r N) r r r r r r r restoredAccountr r r r rU rU s **+;Q?/r rU c < \ rS rSrSr\R " S5 rSrg)r i zRequest message for UndeleteWorkforcePoolInstalledApp.
Fields:
validateOnly: Optional. If set, validate the request and preview the
response, but do not actually post it.
r r NrP r r r r r rQ r r c \ rS rSrSrSrg)r: i z5Request message for UndeleteWorkforcePoolProviderKey.r Nr r r r r: r: s >r r: c \ rS rSrSrSrg)rh i z2Request message for UndeleteWorkforcePoolProvider.r Nr r r r rh rh s ;r rh c \ rS rSrSrSrg)rd i zNAgentspace only. Request message for
UndeleteWorkforcePoolProviderScimTenant.
r Nr r r r rd rd r rd c \ rS rSrSrSrg)r` i zMAgentspace only. Request message for
UndeleteWorkforcePoolProviderScimToken.
r Nr r r r r` r` r[ r r` c \ rS rSrSrSrg)r i z*Request message for UndeleteWorkforcePool.r Nr r r r r r s 3r r c \ rS rSrSrSrg)rv i z1Request message for UndeleteWorkforcePoolSubject.r Nr r r r rv rv :r rv c \ rS rSrSrSrg)r i z@Request message for UndeleteWorkloadIdentityPoolManagedIdentity.r Nr r r r r r s Ir r c \ rS rSrSrSrg)r> i# z:Request message for UndeleteWorkloadIdentityPoolNamespace.r Nr r r r r> r> # Cr r> c \ rS rSrSrSrg)rh i' zWorkforcePoolProvider.AttributeMappingValue.AdditionalPropertyi An additional property for a AttributeMappingValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
r r r Nr r r r r r~ r r r r Tr
r Nr r r r AttributeMappingValuer| s3 5n 'Y . . ' %112FTXYr r r r r5 r6 r r r r r r r r r r r
r N)!r r r r r r r7 rx r4 r r r r r9 attributeConditionr attributeMappingattributeSyncIntervalr r detailedAuditLoggingr8 r r extendedAttributesOauth2ClientextraAttributesOauth2Clientr: oidcsamlr; scimUsager< r r r r r# r# so gR
Y^^
!!"89CZi / / CZ :CZJ !,,Q/ ++,CQG#//2%%a(+"//2
#
#A
&(%%a(+$$Q'*#,#9#9:|~ $A ) 6 67y{} ~ r "$ KR P$ KR P$!!"> $$Q'* " "9a 0' q !$ (()JAN
4a
8% 0!4#r r, c \ rS rSrSr " S S\R 5 r\R " S5 " S S\R 5 5 r \R " S5 r
\R " SS 5 r\R " S
5 r\R " S 5 r\R " S 5 r\R " S
5 r\R " S5 r\R* " SS5 rSrg)rE i! a Agentspace only. Represents a SCIM tenant. Used for provisioning and
managing identity data (such as Users and Groups) in cross-domain
environments.
Enums:
StateValueValuesEnum: Output only. Agentspace only. The state of the
tenant.
Messages:
ClaimMappingValue: Optional. Agentspace only. Maps BYOID claims to SCIM
claims.
Fields:
baseUri: 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.
description: Optional. Agentspace only. The description of the SCIM
tenant. Cannot exceed 256 characters.
displayName: Optional. Agentspace only. The display name of the SCIM
tenant. Cannot exceed 32 characters.
name: Identifier. Agentspace only. The resource name of the SCIM Tenant.
Format: `locations/{location}/workforcePools/{workforce_pool}/providers/
{workforce_pool_provider}/scimTenants/{scim_tenant}`
purgeTime: Output only. Agentspace only. The timestamp that represents the
time when the SCIM tenant is purged.
serviceAgent: Output only. Service Agent created by SCIM Tenant API. SCIM
tokens created under this tenant will be attached to this service agent.
state: Output only. Agentspace only. The state of the tenant.
c $ \ rS rSrSrSrSrSrSrg)4WorkforcePoolProviderScimTenant.StateValueValuesEnumiC ab Output only. Agentspace only. The state of the tenant.
Values:
STATE_UNSPECIFIED: Agentspace only. State unspecified.
ACTIVE: Agentspace only. The tenant is active and may be used to
provision users and groups.
DELETED: Agentspace only. The tenant is soft-deleted. Soft-deleted
tenants are permanently deleted after approximately 30 days.
r r r r Nr0 r r r r4 r C r r r4 r c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
1WorkforcePoolProviderScimTenant.ClaimMappingValueiQ zOptional. Agentspace only. Maps BYOID claims to SCIM claims.
Messages:
AdditionalProperty: An additional property for a ClaimMappingValue
object.
Fields:
additionalProperties: Additional properties of type ClaimMappingValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)DWorkforcePoolProviderScimTenant.ClaimMappingValue.AdditionalPropertyi] zAn additional property for a ClaimMappingValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
r r r Nr r r r r r ] r r r r Tr
r Nr r r r ClaimMappingValuer Q s2 'Y . . ' %112FTXYr r r r r5 r6 r r r r r N)r r r r r r r7 r4 r r r r r9 baseUrir claimMappingr r r: purgeTime serviceAgentr; r< r r r r rE rE ! s B Y^^ !!"89Z)++ Z :Z0
! !! $'''(;Q?,%%a(+%%a(+ q !$##A&)&&q),
4a
8%r rE c \ rS rSrSr " S S\R 5 r\R " S5 r \R " S5 r
\R " S5 r \R " SS5 r
S rg
) rS it a Agentspace only. Represents a token for the
WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning
requests.
Enums:
StateValueValuesEnum: Output only. Agentspace only. The state of the
token.
Fields:
displayName: Optional. Agentspace only. The display name of the SCIM
token. Cannot exceed 32 characters.
name: Identifier. Agentspace only. The resource name of the SCIM Token.
Format: `locations/{location}/workforcePools/{workforce_pool}/providers/
{workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
securityToken: Output only. Agentspace only. The token string. Provide
this to the IdP for authentication. Will be set only during creation.
state: Output only. Agentspace only. The state of the token.
c $ \ rS rSrSrSrSrSrSrg)3WorkforcePoolProviderScimToken.StateValueValuesEnumi a^ Output only. Agentspace only. The state of the token.
Values:
STATE_UNSPECIFIED: Agentspace only. State unspecified.
ACTIVE: Agentspace only. The token is active and may be used to
provision users and groups.
DELETED: Agentspace only. The token is soft-deleted. Soft-deleted tokens
are permanently deleted after approximately 30 days.
r r r r Nr0 r r r r4 r r r r4 r r r5 r6 r N)r r r r r r r7 r4 r9 r r:
securityTokenr; r< r r r r rS rS t s\ & Y^^ %%a(+ q !$''*-
4a
8%r rS c \ rS rSrSr " S S\R 5 r " S S\R 5 r\R " S5 r
\R " S5 r \R " S 5 r
\R " S
5 r\R " S 5 r\R " S S
5 r\R " SS5 r\R& " SS5 r\R " S5 r\R " S5 r\R& " SS5 rSrg)r i a Represents a collection of workload identities. You can define IAM
policies to grant these identities access to Google Cloud resources.
Enums:
ModeValueValuesEnum: Immutable. The mode the pool is operating in.
StateValueValuesEnum: Output only. The state of the pool.
Fields:
description: Optional. A description of the pool. Cannot exceed 256
characters.
disabled: Optional. Whether the pool is disabled. 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.
displayName: Optional. A display name for the pool. Cannot exceed 32
characters.
enableMeshCaCompatibility: Optional. If set to true, - the generated trust
bundle for the workloads in this trust domain will include the Cloud
Service Mesh certificate authority's root CA certificates. - the
certificate chain for the workload in this trust domain will be signed
by the Cloud Service Mesh certificate authority root CA.
expireTime: Output only. Time after which the workload identity pool will
be permanently purged and cannot be recovered.
inlineCertificateIssuanceConfig: Optional. Defines the Certificate
Authority (CA) pool resources and configurations required for issuance
and rotation of mTLS workload certificates.
inlineTrustConfig: Optional. Represents config to add additional trusted
trust domains.
mode: Immutable. The mode the pool is operating in.
name: Output only. The resource name of the pool.
sessionDuration: Overrides the lifespan of access tokens issued when
federating using this pool. If not set, the lifespan of issued access
tokens is computed based on the type of identity provider: - For AWS
providers, the default access token lifespan is equal to 15 minutes. -
For OIDC providers, the default access token lifespan is equal to the
remaining lifespan of the exchanged OIDC ID token, with a maximum limit
of 1 hour. If set, session duration must be between 2 minutes and 12
hours. Organization administrators can further restrict the maximum
allowed session_duration value using the iam-
workloadIdentitySessionDuration Resource Setting.
state: Output only. The state of the pool.
c $ \ rS rSrSrSrSrSrSrg)(WorkloadIdentityPool.ModeValueValuesEnumi a Immutable. The mode the pool is operating in.
Values:
MODE_UNSPECIFIED: State unspecified. New pools should not use this mode.
Pools with an unspecified mode will operate as if they are in
federation-only mode.
FEDERATION_ONLY: Federation-only mode. Federation-only pools can only be
used for federating external workload identities into Google Cloud.
Unless otherwise noted, no structure or format constraints are applied
to workload identities in a federation-only pool, and you cannot
create any resources within the pool besides providers.
TRUST_DOMAIN: Trust-domain mode. Trust-domain pools can be used to
assign identities to Google Cloud workloads. All identities within a
trust-domain pool must consist of a single namespace and individual
workload identifier. The subject identifier for all identities must
conform to the following format: `ns//sa/`
WorkloadIdentityPoolProviders cannot be created within trust-domain
pools.
r r r r N) r r r r r MODE_UNSPECIFIEDFEDERATION_ONLY TRUST_DOMAINr r r r ModeValueValuesEnumr s & OLr r c $ \ rS rSrSrSrSrSrSrg))WorkloadIdentityPool.StateValueValuesEnumi ac Output only. The state of the pool.
Values:
STATE_UNSPECIFIED: State unspecified.
ACTIVE: The pool is active, and may be used in Google Cloud policies.
DELETED: The pool is soft-deleted. Soft-deleted pools are permanently
deleted after approximately 30 days. You can restore a soft-deleted
pool using UndeleteWorkloadIdentityPool. You cannot reuse the ID of a
soft-deleted pool until it is permanently deleted. While a pool is
deleted, you cannot use it to exchange tokens, or use existing tokens
to access resources. If the pool is undeleted, existing tokens grant
access again.
r r r r Nr0 r r r r4 r rj r r4 r r r5 r6 r r r r r r r r r r N)r r r r r r r7 r r4 r9 r r r8 r enableMeshCaCompatibilityr r inlineCertificateIssuanceConfiginlineTrustConfigr; moder: rl r< r r r r r r s )VINN 0Y^^ $ %%a(+
#
#A
&(%%a(+ ' 4 4Q 7$$Q'*$-$:$:;\^_$`! ,,-@!D 2A 6$ q !$ ))"-/
4b
9%r r c \ rS rSrSr " S S\R 5 r\R " S5 r \R " S5 r \R " S5 r \R " S5 r
\R " SS 5 rS
rg ) r i a Represents a managed identity for a workload identity pool namespace.
Enums:
StateValueValuesEnum: Output only. The state of the managed identity.
Fields:
description: Optional. A description of the managed identity. Cannot
exceed 256 characters.
disabled: Optional. Whether the managed identity is disabled. If disabled,
credentials may no longer be issued for the identity, however existing
credentials will still be accepted until they expire.
expireTime: Output only. Time after which the managed identity will be
permanently purged and cannot be recovered.
name: Output only. The resource name of the managed identity.
state: Output only. The state of the managed identity.
c $ \ rS rSrSrSrSrSrSrg)8WorkloadIdentityPoolManagedIdentity.StateValueValuesEnumi a Output only. The state of the managed identity.
Values:
STATE_UNSPECIFIED: State unspecified.
ACTIVE: The managed identity is active.
DELETED: The managed identity is soft-deleted. Soft-deleted managed
identities are permanently deleted after approximately 30 days. You
can restore a soft-deleted managed identity using
UndeleteWorkloadIdentityPoolManagedIdentity. You cannot reuse the ID
of a soft-deleted managed identity until it is permanently deleted.
r r r r Nr0 r r r r4 r
FGr r4 r r r5 r6 r r N)r r r r r r r7 r4 r9 r r r8 r r: r; r< r r r r r r sl "Y^^ %%a(+
#
#A
&($$Q'* q !$
4a
8%r r c \ rS rSrSr " S S\R 5 r\R " S5 r \R " S5 r \R " S5 r \R " S5 r
\R " S S
5 r\R " SS 5 rS rg
)r i( a1 Represents a namespace for a workload identity pool. Namespaces are used
to segment identities within the pool.
Enums:
StateValueValuesEnum: Output only. The state of the namespace.
Fields:
description: Optional. A description of the namespace. Cannot exceed 256
characters.
disabled: Optional. Whether the namespace is disabled. If disabled,
credentials may no longer be issued for identities within this
namespace, however existing credentials will still be accepted until
they expire.
expireTime: Output only. Time after which the namespace will be
permanently purged and cannot be recovered.
name: Output only. The resource name of the namespace.
ownerService: Output only. The Google Cloud service that owns this
namespace.
state: Output only. The state of the namespace.
c $ \ rS rSrSrSrSrSrSrg)2WorkloadIdentityPoolNamespace.StateValueValuesEnumi> a Output only. The state of the namespace.
Values:
STATE_UNSPECIFIED: State unspecified.
ACTIVE: The namespace is active.
DELETED: The namespace is soft-deleted. Soft-deleted namespaces are
permanently deleted after approximately 30 days. You can restore a
soft-deleted namespace using UndeleteWorkloadIdentityPoolNamespace.
You cannot reuse the ID of a soft-deleted namespace until it is
permanently deleted.
r r r r Nr0 r r r r4 r > r r r4 r r r5 r6 r r r r N)r r r r r r r7 r4 r9 r r r8 r r: r ownerServicer; r< r r r r r r ( s~ *Y^^ %%a(+
#
#A
&($$Q'* q !$'':,
4a
8%r r c \ rS rSrSrSrg)%WorkloadIdentityPoolOperationMetadataiV z:Metadata for long-running WorkloadIdentityPool operations.r Nr r r r r r V rb r r c R \ rS rSrSr " S S\R 5 r\R " S5 " S S\R 5 5 r \R " S5 r
\R " SS 5 r\R " S
S 5 r\R " S 5 r\R$ " S
5 r\R " S5 r\R " S5 r\R " S5 r\R " SS5 r\R " SS5 r\R2 " SS5 r\R " SS5 rSr g)rR iZ a A configuration for an external identity provider.
Enums:
StateValueValuesEnum: Output only. The state of the provider.
Messages:
AttributeMappingValue: Optional. Maps attributes from authentication
credentials issued by an external identity provider to Google Cloud
attributes, such as `subject` and `segment`. Each key must be a string
specifying the Google Cloud IAM attribute to map to. The following keys
are supported: * `google.subject`: The principal IAM is authenticating.
You can reference this value in IAM bindings. This is also the subject
that appears in Cloud Logging logs. Cannot exceed 127 bytes. *
`google.groups`: Groups the external identity belongs to. You can grant
groups access to resources using an IAM `principalSet` binding; access
applies to all members of the group. You can also provide custom
attributes by specifying `attribute.{custom_attribute}`, where
`{custom_attribute}` is the name of the custom attribute to be mapped.
You can define a maximum of 50 custom attributes. The maximum length of
a mapped attribute key is 100 characters, and the key may only contain
the characters [a-z0-9_]. You can reference these attributes in IAM
policies to define fine-grained access for a workload to Google Cloud
resources. For example: * `google.subject`: `principal://iam.googleapis.
com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}
/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/
projects/{project}/locations/{location}/workloadIdentityPools/{pool}/gro
up/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.google
apis.com/projects/{project}/locations/{location}/workloadIdentityPools/{
pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common
Expression Language] (https://opensource.google/projects/cel) function
that maps an identity provider credential to the normalized attribute
specified by the corresponding map key. You can use the `assertion`
keyword in the expression to access a JSON representation of the
authentication credential issued by the provider. The maximum length of
an attribute mapping expression is 2048 characters. When evaluated, the
total size of all mapped attributes must not exceed 8KB. For AWS
providers, if no attribute mapping is defined, the following default
mapping applies: ``` { "google.subject":"assertion.arn",
"attribute.aws_role": "assertion.arn.contains('assumed-role')" " ?
assertion.arn.extract('{account_arn}assumed-role/')" " + 'assumed-
role/'" " + assertion.arn.extract('assumed-role/{role_name}/')" " :
assertion.arn", } ``` If any custom attribute mappings are defined, they
must include a mapping to the `google.subject` attribute. For OIDC
providers, you must supply a custom mapping, which must include the
`google.subject` attribute. For example, the following maps the `sub`
claim of the incoming credential to the `subject` attribute on a Google
token: ``` {"google.subject": "assertion.sub"} ```
Fields:
attributeCondition: Optional. [A Common Expression
Language](https://opensource.google/projects/cel) expression, in plain
text, to restrict what otherwise valid authentication credentials issued
by the provider should not be accepted. The expression must output a
boolean representing whether to allow the federation. The following
keywords may be referenced in the expressions: * `assertion`: JSON
representing the authentication credential issued by the provider. *
`google`: The Google attributes mapped from the assertion in the
`attribute_mappings`. * `attribute`: The custom attributes mapped from
the assertion in the `attribute_mappings`. The maximum length of the
attribute condition expression is 4096 characters. If unspecified, all
valid authentication credential are accepted. The following example
shows how to only allow credentials with a mapped `google.groups` value
of `admins`: ``` "'admins' in google.groups" ```
attributeMapping: Optional. Maps attributes from authentication
credentials issued by an external identity provider to Google Cloud
attributes, such as `subject` and `segment`. Each key must be a string
specifying the Google Cloud IAM attribute to map to. The following keys
are supported: * `google.subject`: The principal IAM is authenticating.
You can reference this value in IAM bindings. This is also the subject
that appears in Cloud Logging logs. Cannot exceed 127 bytes. *
`google.groups`: Groups the external identity belongs to. You can grant
groups access to resources using an IAM `principalSet` binding; access
applies to all members of the group. You can also provide custom
attributes by specifying `attribute.{custom_attribute}`, where
`{custom_attribute}` is the name of the custom attribute to be mapped.
You can define a maximum of 50 custom attributes. The maximum length of
a mapped attribute key is 100 characters, and the key may only contain
the characters [a-z0-9_]. You can reference these attributes in IAM
policies to define fine-grained access for a workload to Google Cloud
resources. For example: * `google.subject`: `principal://iam.googleapis.
com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}
/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/
projects/{project}/locations/{location}/workloadIdentityPools/{pool}/gro
up/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.google
apis.com/projects/{project}/locations/{location}/workloadIdentityPools/{
pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common
Expression Language] (https://opensource.google/projects/cel) function
that maps an identity provider credential to the normalized attribute
specified by the corresponding map key. You can use the `assertion`
keyword in the expression to access a JSON representation of the
authentication credential issued by the provider. The maximum length of
an attribute mapping expression is 2048 characters. When evaluated, the
total size of all mapped attributes must not exceed 8KB. For AWS
providers, if no attribute mapping is defined, the following default
mapping applies: ``` { "google.subject":"assertion.arn",
"attribute.aws_role": "assertion.arn.contains('assumed-role')" " ?
assertion.arn.extract('{account_arn}assumed-role/')" " + 'assumed-
role/'" " + assertion.arn.extract('assumed-role/{role_name}/')" " :
assertion.arn", } ``` If any custom attribute mappings are defined, they
must include a mapping to the `google.subject` attribute. For OIDC
providers, you must supply a custom mapping, which must include the
`google.subject` attribute. For example, the following maps the `sub`
claim of the incoming credential to the `subject` attribute on a Google
token: ``` {"google.subject": "assertion.sub"} ```
aws: An Amazon Web Services identity provider.
description: Optional. A description for the provider. Cannot exceed 256
characters.
disabled: Optional. Whether the provider is disabled. You cannot use a
disabled provider to exchange tokens. However, existing tokens still
grant access.
displayName: Optional. A display name for the provider. Cannot exceed 32
characters.
expireTime: Output only. Time after which the workload identity pool
provider will be permanently purged and cannot be recovered.
name: Output only. The resource name of the provider.
oidc: An OpenId Connect 1.0 identity provider.
saml: An SAML 2.0 identity provider.
state: Output only. The state of the provider.
x509: An X.509-type identity provider.
c $ \ rS rSrSrSrSrSrSrg)1WorkloadIdentityPoolProvider.StateValueValuesEnumi a Output only. The state of the provider.
Values:
STATE_UNSPECIFIED: State unspecified.
ACTIVE: The provider is active, and may be used to validate
authentication credentials.
DELETED: The provider is soft-deleted. Soft-deleted providers are
permanently deleted after approximately 30 days. You can restore a
soft-deleted provider using UndeleteWorkloadIdentityPoolProvider. You
cannot reuse the ID of a soft-deleted provider until it is permanently
deleted.
r r r r Nr0 r r r r4 r s
FGr r4 r c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
2WorkloadIdentityPoolProvider.AttributeMappingValuei a Optional. Maps attributes from authentication credentials issued by an
external identity provider to Google Cloud attributes, such as `subject`
and `segment`. Each key must be a string specifying the Google Cloud IAM
attribute to map to. The following keys are supported: * `google.subject`:
The principal IAM is authenticating. You can reference this value in IAM
bindings. This is also the subject that appears in Cloud Logging logs.
Cannot exceed 127 bytes. * `google.groups`: Groups the external identity
belongs to. You can grant groups access to resources using an IAM
`principalSet` binding; access applies to all members of the group. You
can also provide custom attributes by specifying
`attribute.{custom_attribute}`, where `{custom_attribute}` is the name of
the custom attribute to be mapped. You can define a maximum of 50 custom
attributes. The maximum length of a mapped attribute key is 100
characters, and the key may only contain the characters [a-z0-9_]. You can
reference these attributes in IAM policies to define fine-grained access
for a workload to Google Cloud resources. For example: * `google.subject`:
`principal://iam.googleapis.com/projects/{project}/locations/{location}/wo
rkloadIdentityPools/{pool}/subject/{value}` * `google.groups`: `principalS
et://iam.googleapis.com/projects/{project}/locations/{location}/workloadId
entityPools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `princ
ipalSet://iam.googleapis.com/projects/{project}/locations/{location}/workl
oadIdentityPools/{pool}/attribute.{custom_attribute}/{value}` Each value
must be a [Common Expression Language]
(https://opensource.google/projects/cel) function that maps an identity
provider credential to the normalized attribute specified by the
corresponding map key. You can use the `assertion` keyword in the
expression to access a JSON representation of the authentication
credential issued by the provider. The maximum length of an attribute
mapping expression is 2048 characters. When evaluated, the total size of
all mapped attributes must not exceed 8KB. For AWS providers, if no
attribute mapping is defined, the following default mapping applies: ``` {
"google.subject":"assertion.arn", "attribute.aws_role":
"assertion.arn.contains('assumed-role')" " ?
assertion.arn.extract('{account_arn}assumed-role/')" " + 'assumed-role/'"
" + assertion.arn.extract('assumed-role/{role_name}/')" " :
assertion.arn", } ``` If any custom attribute mappings are defined, they
must include a mapping to the `google.subject` attribute. For OIDC
providers, you must supply a custom mapping, which must include the
`google.subject` attribute. For example, the following maps the `sub`
claim of the incoming credential to the `subject` attribute on a Google
token: ``` {"google.subject": "assertion.sub"} ```
Messages:
AdditionalProperty: An additional property for a AttributeMappingValue
object.
Fields:
additionalProperties: Additional properties of type
AttributeMappingValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)EWorkloadIdentityPoolProvider.AttributeMappingValue.AdditionalPropertyi r r r r Nr r r r r r r r r r Tr
r Nr r r r r r s3 1f 'Y . . ' %112FTXYr r r r r] r5 r6 r r r r r r r r r X509r r N) r r r r r r r7 r4 r r r r r9 r r r awsr r r8 r r r: r r r; r< x509r r r r rR rR Z s wrY^^ " !!"89?Zi / / ?Z :?ZB !,,Q/ ++,CQG ua(#%%a(+
#
#A
&(%%a(+$$Q'* q !$ *$ +$
4b
9% +$r rR c & \ rS rSrSr " S S\R 5 r " S S\R 5 r\R " S5 r
\R " SS 5 r \R " S
5 r
\R " SS 5 r\R " SS 5 rS
rg)r[ i5 a 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.
Enums:
StateValueValuesEnum: Output only. The state of the key.
UseValueValuesEnum: Required. The purpose of the key.
Fields:
expireTime: Output only. Time after which the key will be permanently
purged and cannot be recovered. Note that the key may get purged before
this timestamp if the total limit of keys per provider is crossed.
keyData: Immutable. Public half of the asymmetric key.
name: Output only. The resource name of the key.
state: Output only. The state of the key.
use: Required. The purpose of the key.
c $ \ rS rSrSrSrSrSrSrg)4WorkloadIdentityPoolProviderKey.StateValueValuesEnumiI a{ Output only. The state of the key.
Values:
STATE_UNSPECIFIED: State unspecified.
ACTIVE: The key is active.
DELETED: The key is soft-deleted. Soft-deleted keys are permanently
deleted after approximately 30 days. You can restore a soft-deleted
key using UndeleteWorkloadIdentityPoolProviderKey. While a key is
deleted, you cannot use it during the federation.
r r r r Nr0 r r r r4 r I rp r r4 c \ rS rSrSrSrSrSrg)2WorkloadIdentityPoolProviderKey.UseValueValuesEnumiX zRequired. The purpose of the key.
Values:
KEY_USE_UNSPECIFIED: The key use is not known.
ENCRYPTION: The public key is used for encryption purposes.
r r r N)r r r r r r r r r r r r r X s Jr r r r r r5 r6 r r N)r r r r r r r7 r4 r r9 r r r r: r; r< r r r r r r[ r[ 5 s &
Y^^
9>> $$Q'* " "9a 0' q !$
4a
8% 0!4#r r[ c \ rS rSrSr\R " S5 r\R " SSSS9r \R " S5 r
\R " S S
SS9r S r g )
r ii a5 Defines which workloads can attest an identity within a pool. When a
WorkloadSource is defined under a namespace, matching workloads may receive
any identity within that namespace. When a WorkloadSource is defined under a
managed identity, matching workloads may receive that specific identity.
Each WorkloadSource may set at most 50 workload selectors.
Fields:
etag: Optional. The etag for this resource. If this is provided on update,
it must match the server's etag.
identityAssignments: Optional. Defines how a matched workload has its
identity assigned. This option may only be set when the Workload Source
is defined on a Namespace.
name: Output only. The resource name of the workload source. If ID of the
WorkloadSource resource determines which workloads may be matched. The
following formats are supported: - `project-{project_number}` matches
workloads within the referenced Google Cloud project.
singleAttributeSelectors: Optional. Defines the set of attributes that a
workload must attest in order to be matched by the policy.
r r r Tr
r5 r r6 r N)
r r r r r r r9 r r identityAssignmentsr: r r r r r r r i sW (
q !$!../CQQUV q !$ & 3 34Mq[_ `r r c > \ rS rSrSr\R " SS5 rSrg)r i a An X.509-type identity provider represents a CA. It is trusted to assert
a client identity if the client has a certificate that chains up to this CA.
Fields:
trustStore: Required. A TrustStore. Use this trust store as a wrapper to
config the trust anchor and optional intermediate cas to help build the
trust chain for the incoming end entity certificate. Follow the X.509
guidelines to define those PEM encoded certs. Only one trust store is
currently supported.
r r r N) r r r r r r r
trustStorer r r r r r s %%lA6*r r r1 z$.xgafvr- 1r. 2r z options.requestedPolicyVersionN(' r
__future__r apitools.base.protorpcliter r apitools.base.pyr r packager r r r& r+ r! rB rH rD rY r] ra rh rr rv r r r r r r rc r r r r r r r r r r r r r r r r r
r
r r r r r r" r' r) r+ r0 r2 r4 r7 r9 r= r@ rB rD rI rL rN rP rR rW rY r[ r] r_ rc rg rk rq rs ru ry r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r
r r r r r! r% r' r+ r- r1 r3 r5 r7 r9 r; r= rA rC rE rG rI rK rM rO rQ rV rX rZ r_ ra rc re rg rk rm ro rq ru rw ry r{ r} r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r8 r< r? rB rG rK rN rQ rT rW rZ r] r` rc rf ri rl ro r r r r r r r r r( r rJ r r r r r r r r rs r r rH r r rl r r r r r r$ r rz rH rJ r r r r rU r r: rh rd r` r rv r r> rh rr r~ r r r r# r, rE rS r r r r rR r[ r r AddCustomJsonFieldMappingAddCustomJsonEnumMappingr/ r r r r s] ' < % ( 8** 8"A 1 1 A
AY&&
A ")## "D 1i'' 1 %)## %: 9 !! 9 =Y&& =D"y(( "')
'T"i T"n "9$$ "F $ )) $ 3KY%6%6 3Kl
?)"3"3
? (ki&7&7 (kV.9#4#4 .I 1Y%6%6 1-)"3"3 -!#9 !#H #Y&& #D:)++ :Vy(( V*IAyGXGX IAX$V_VgVg $4d 0A0A d<bI-> = 5y7H7H 5&1y7H7H 11I4E4E 189;L;L 8"19;L;L 11 8I8I 1*9J9J *,1)BSBS 1 qY=N=N q *Y5F5F **1i>O>O 1
Mi6G6G
M ?)BSBS ?( 1)BSBS 1 1y?P?P 1* @Q@Q *,aARAR a"> HYHY >*
1 HYHY
1 1YEVEV 1*iFWFW *._yGXGX _$})J[J[ }"
IDUDU
k9J9J k
II4E4E
I 1i6G6G 1 1Y=N=N 1i 8I8I i"
U):K:K
U [ 0A0A [ 3):): 3<1):): 1< 1i&7&7 1F@7y'8'8 @7F ( (9(9 (@ I9+<+< I>3I4E4E 3&3y?P?P 3( +y?P?P + 1IO>O (" +I4E4E + 11B1B 1*)2C2C *& (93D3D ( Wi6G6G W 5IZIZ 5 4Y=N=N 4&1Y=N=N 1
59CTCT
5 1):K:K 159K\K\ 54*9;L;L *(
5S\SdSd
5 =yGXGX =*1yGXGX 15YM^M^ 5"1IDUDU 15U^UfUf 54*YEVEV *( 5dmdudu 5 CXaXiXi C*1XaXiXi 15^g^o^o 5"1U^UfUf 15fofwfw 54*V_VgVg **1_h_p_p 1
iW`WhWh
i 5gpgxgx 5 Wenevev W I^g^o^o I"Udmdudu U" GZcZkZk G .gpgxgx .( 1gpgxgx 1 1dmdudu 13enevev 3$1nwnn 1?fofwfw ?& 1iN_N_ 1
]iFWFW
] 5V_VgVg 5 WT]TeTe W IYM^M^ I"US\SdSd U$ {IZIZ { .V_VgVg .( 1V_VgVg 1 1S\SdSd 13T]TeTe 3$1]f]n]n 1?U^UfUf ?&1IDUDU 1 KI 1i.?.? 1 1i.?.? 1*1y/@/@ 1.1i.?.? 1.5I4E4E 5419+<+< 1*1)2C2C 101)2C2C 1,193D3D 121)2C2C 12(Iy/@/@ (IV*1 0A0A *1Z_)2C2C _0'I,=,= '&WY->-> W.
II4E4E
I A 0A0A A2?y/@/@ ?2
U):K:K
U ] 0A0A ]. 1** 1F@7)++ @7Fa** a"n1i&7&7 n1b?T )) ?TD ,Y&& ,6+i 6+r. )) ." G** GH0"" H0V +9#4#4 + ]):): ] Iy 0 0 I
; ))
;GY%6%6 G
+)"3"3
+ eY->-> e
cI,=,=
c
q93D3D
q
o)2C2C
o
]):):
]
M!2!2
M
z 8I8I
z
m1B1B
m q93D3D q
k 0A0A
k
[ (9(9
[
O)"3"3
O`:)## `:F (I - - (D &9 &@i8 !! i8X" )) "4.9$$ .
(!2!2
( 8#"" 8#v
?i''
?KGY
KG\K)## K .I$5$5 . JY%6%6 J!7!2!2 !7H
;)"3"3
;'i&7&7 '(
Gy'8'8
G Mi&7&7 MBA9#4#4 A:#9 :#z,9 ,,0&Y&& 0&fT. )) T.n$I%% $Q!2!2 Q()++ (" (i'' ( &y(( &$%Y&& %('i'' '$#i / / #*<.i / / <.~0%Y
0%f
8 1 1
88!2!2 8,)## ,3"" 3.+!2!2 +!)++ !/I$5$5 /@Y%6%6 @+y/@/@ +?i.?.? ?<9+<+< <Y5F5F I4E4E 49#4#4 4;)*;*; ;J9J9J JD93D3D DFY5F5F FC)2C2C C;)*;*; ;
*Y%6%6
*=9I%% =9@5( 1 1 5(p]:I - - ]:@ F5y 0 0 F5RP9i&7&7 P9f%9Y%6%6 %9P`:9,, `:F&9)*;*; &9R+9I$5$5 +9\DI,=,= DX,9#4#4 X,v15i&7&7 15haY&& a6 79 7 " "Z4 ! !114> ! !114> " "13SUuwr