Google Git
Sign in
chromium / external / github.com / google / google-api-python-client / gh-pages / . / docs / dyn / iam_v1.projects.serviceAccounts.html
blob: 430359657162ea6a111109376b1e79dadd910e69 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="iam_v1.html">Identity and Access Management (IAM) API</a> . <a href="iam_v1.projects.html">projects</a> . <a href="iam_v1.projects.serviceAccounts.html">serviceAccounts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="iam_v1.projects.serviceAccounts.keys.html">keys()</a></code>
</p>
<p class="firstline">Returns the keys Resource.</p>
<p class="toc_element">
<code><a href="#create">create(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a ServiceAccount.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a ServiceAccount.</p>
<p class="toc_element">
<code><a href="#disable">disable(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Disables a ServiceAccount immediately.</p>
<p class="toc_element">
<code><a href="#enable">enable(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Enables a ServiceAccount that was disabled by</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a ServiceAccount.</p>
<p class="toc_element">
<code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the IAM policy that is attached to a ServiceAccount. This IAM</p>
<p class="toc_element">
<code><a href="#list">list(name, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists every ServiceAccount that belongs to a specific project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Patches a ServiceAccount.</p>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the IAM policy that is attached to a ServiceAccount.</p>
<p class="toc_element">
<code><a href="#signBlob">signBlob(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">**Note:** This method is deprecated and will stop working on July 1, 2021.</p>
<p class="toc_element">
<code><a href="#signJwt">signJwt(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">**Note:** This method is deprecated and will stop working on July 1, 2021.</p>
<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Tests whether the caller has the specified permissions on a</p>
<p class="toc_element">
<code><a href="#undelete">undelete(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Restores a deleted ServiceAccount.</p>
<p class="toc_element">
<code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">**Note:** We are in the process of deprecating this method. Use</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(name, body=None, x__xgafv=None)</code>
<pre>Creates a ServiceAccount.
Args:
name: string, Required. The resource name of the project associated with the service
accounts, such as `projects/my-project-123`. (required)
body: object, The request body.
The object takes the form of:
{ # The service account create request.
&quot;accountId&quot;: &quot;A String&quot;, # Required. The account id that is used to generate the service account
# email address and a stable unique id. It is unique within a project,
# must be 6-30 characters long, and match the regular expression
# `[a-z]([-a-z0-9]*[a-z0-9])` to comply with RFC1035.
&quot;serviceAccount&quot;: { # An IAM service account. # The ServiceAccount resource to
# create. Currently, only the following values are user assignable:
# `display_name` and `description`.
#
# 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.
&quot;disabled&quot;: True or False, # Output only. Whether the service account is disabled.
&quot;uniqueId&quot;: &quot;A String&quot;, # 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.
&quot;projectId&quot;: &quot;A String&quot;, # Output only. The ID of the project that owns the service account.
&quot;etag&quot;: &quot;A String&quot;, # Deprecated. Do not use.
&quot;email&quot;: &quot;A String&quot;, # Output only. The email address of the service account.
&quot;name&quot;: &quot;A String&quot;, # 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 get 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.
&quot;displayName&quot;: &quot;A String&quot;, # Optional. A user-specified, human-readable name for the service account. The maximum
# length is 100 UTF-8 bytes.
&quot;oauth2ClientId&quot;: &quot;A String&quot;, # Output only. The OAuth 2.0 client ID for the service account.
&quot;description&quot;: &quot;A String&quot;, # Optional. A user-specified, human-readable description of the service account. The
# maximum length is 256 UTF-8 bytes.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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.
&quot;disabled&quot;: True or False, # Output only. Whether the service account is disabled.
&quot;uniqueId&quot;: &quot;A String&quot;, # 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.
&quot;projectId&quot;: &quot;A String&quot;, # Output only. The ID of the project that owns the service account.
&quot;etag&quot;: &quot;A String&quot;, # Deprecated. Do not use.
&quot;email&quot;: &quot;A String&quot;, # Output only. The email address of the service account.
&quot;name&quot;: &quot;A String&quot;, # 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 get 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.
&quot;displayName&quot;: &quot;A String&quot;, # Optional. A user-specified, human-readable name for the service account. The maximum
# length is 100 UTF-8 bytes.
&quot;oauth2ClientId&quot;: &quot;A String&quot;, # Output only. The OAuth 2.0 client ID for the service account.
&quot;description&quot;: &quot;A String&quot;, # Optional. A user-specified, human-readable description of the service account. The
# maximum length is 256 UTF-8 bytes.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a ServiceAccount.
**Warning:** After you delete a service account, you might not be able to
undelete it. If you know that you need to re-enable the service account in
the future, use DisableServiceAccount instead.
If you delete a service account, IAM permanently removes the service
account 30 days later. Google Cloud cannot recover the service account
after it is permanently removed, even if you file a support request.
To help avoid unplanned outages, we recommend that you disable the service
account before you delete it. Use DisableServiceAccount to disable the
service account, then wait at least 24 hours and watch for unintended
consequences. If there are no unintended consequences, you can delete the
service account.
Args:
name: string, Required. The resource name of the service account in the following format:
`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
Using `-` as a wildcard for the `PROJECT_ID` will infer the project from
the account. The `ACCOUNT` value can be the `email` address or the
`unique_id` of the service account. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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);
# }
#
# The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="disable">disable(name, body=None, x__xgafv=None)</code>
<pre>Disables a ServiceAccount immediately.
If an application uses the service account to authenticate, that
application can no longer call Google APIs or access Google Cloud
resources. Existing access tokens for the service account are rejected, and
requests for new access tokens will fail.
To re-enable the service account, use EnableServiceAccount. After you
re-enable the service account, its existing access tokens will be accepted,
and you can request new access tokens.
To help avoid unplanned outages, we recommend that you disable the service
account before you delete it. Use this method to disable the service
account, then wait at least 24 hours and watch for unintended consequences.
If there are no unintended consequences, you can delete the service account
with DeleteServiceAccount.
Args:
name: string, The resource name of the service account in the following format:
`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
Using `-` as a wildcard for the `PROJECT_ID` will infer the project from
the account. The `ACCOUNT` value can be the `email` address or the
`unique_id` of the service account. (required)
body: object, The request body.
The object takes the form of:
{ # The service account disable request.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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);
# }
#
# The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="enable">enable(name, body=None, x__xgafv=None)</code>
<pre>Enables a ServiceAccount that was disabled by
DisableServiceAccount.
If the service account is already enabled, then this method has no effect.
If the service account was disabled by other means—for example, if Google
disabled the service account because it was compromised—you cannot use this
method to enable the service account.
Args:
name: string, The resource name of the service account in the following format:
`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
Using `-` as a wildcard for the `PROJECT_ID` will infer the project from
the account. The `ACCOUNT` value can be the `email` address or the
`unique_id` of the service account. (required)
body: object, The request body.
The object takes the form of:
{ # The service account enable request.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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);
# }
#
# The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a ServiceAccount.
Args:
name: string, Required. The resource name of the service account in the following format:
`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
Using `-` as a wildcard for the `PROJECT_ID` will infer the project from
the account. The `ACCOUNT` value can be the `email` address or the
`unique_id` of the service account. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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.
&quot;disabled&quot;: True or False, # Output only. Whether the service account is disabled.
&quot;uniqueId&quot;: &quot;A String&quot;, # 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.
&quot;projectId&quot;: &quot;A String&quot;, # Output only. The ID of the project that owns the service account.
&quot;etag&quot;: &quot;A String&quot;, # Deprecated. Do not use.
&quot;email&quot;: &quot;A String&quot;, # Output only. The email address of the service account.
&quot;name&quot;: &quot;A String&quot;, # 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 get 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.
&quot;displayName&quot;: &quot;A String&quot;, # Optional. A user-specified, human-readable name for the service account. The maximum
# length is 100 UTF-8 bytes.
&quot;oauth2ClientId&quot;: &quot;A String&quot;, # Output only. The OAuth 2.0 client ID for the service account.
&quot;description&quot;: &quot;A String&quot;, # Optional. A user-specified, human-readable description of the service account. The
# maximum length is 256 UTF-8 bytes.
}</pre>
</div>
<div class="method">
<code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
<pre>Gets the IAM policy that is attached to a ServiceAccount. This IAM
policy specifies which members have access to the service account.
This method does not tell you whether the service account has been granted
any roles on other resources. To check whether a service account has role
grants on a resource, use the `getIamPolicy` method for that resource. For
example, to view the role grants for a project, call the Resource Manager
API&#x27;s
[`projects.getIamPolicy`](https://cloud.google.com/resource-manager/reference/rest/v1/projects/getIamPolicy)
method.
Args:
resource: string, REQUIRED: The resource for which the policy is being requested.
See the operation documentation for the appropriate value for this field. (required)
options_requestedPolicyVersion: integer, Optional. The policy format version to be returned.
Valid values are 0, 1, and 3. Requests specifying an invalid value will be
rejected.
Requests for policies with any conditional bindings must specify version 3.
Policies without any conditional bindings may specify any valid value 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).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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` to a single `role`. Members 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:**
#
# {
# &quot;bindings&quot;: [
# {
# &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
# &quot;members&quot;: [
# &quot;user:mike@example.com&quot;,
# &quot;group:admins@example.com&quot;,
# &quot;domain:google.com&quot;,
# &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot;
# ]
# },
# {
# &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
# &quot;members&quot;: [
# &quot;user:eve@example.com&quot;
# ],
# &quot;condition&quot;: {
# &quot;title&quot;: &quot;expirable access&quot;,
# &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
# &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
# }
# }
# ],
# &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
# &quot;version&quot;: 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 &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
&quot;etag&quot;: &quot;A String&quot;, # `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.
&quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
# The configuration determines which permission types are logged, and what
# identities, if any, are exempted from logging.
# An AuditConfig must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
# the union of the two AuditConfigs is used for that service: the log_types
# specified in each AuditConfig are enabled, and the exempted_members in each
# AuditLogConfig are exempted.
#
# Example Policy with multiple AuditConfigs:
#
# {
# &quot;audit_configs&quot;: [
# {
# &quot;service&quot;: &quot;allServices&quot;,
# &quot;audit_log_configs&quot;: [
# {
# &quot;log_type&quot;: &quot;DATA_READ&quot;,
# &quot;exempted_members&quot;: [
# &quot;user:jose@example.com&quot;
# ]
# },
# {
# &quot;log_type&quot;: &quot;DATA_WRITE&quot;
# },
# {
# &quot;log_type&quot;: &quot;ADMIN_READ&quot;
# }
# ]
# },
# {
# &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
# &quot;audit_log_configs&quot;: [
# {
# &quot;log_type&quot;: &quot;DATA_READ&quot;
# },
# {
# &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
# &quot;exempted_members&quot;: [
# &quot;user:aliya@example.com&quot;
# ]
# }
# ]
# }
# ]
# }
#
# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
# logging. It also exempts jose@example.com from DATA_READ logging, and
# aliya@example.com from DATA_WRITE logging.
&quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions.
# Example:
#
# {
# &quot;audit_log_configs&quot;: [
# {
# &quot;log_type&quot;: &quot;DATA_READ&quot;,
# &quot;exempted_members&quot;: [
# &quot;user:jose@example.com&quot;
# ]
# },
# {
# &quot;log_type&quot;: &quot;DATA_WRITE&quot;
# }
# ]
# }
#
# This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
# jose@example.com from DATA_READ logging.
&quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
&quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
# permission.
# Follows the same format of Binding.members.
&quot;A String&quot;,
],
},
],
&quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
&quot;version&quot;: 42, # 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).
&quot;bindings&quot;: [ # Associates a list of `members` to 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 member.
{ # Associates `members` with a `role`.
&quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform 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.
#
# * `user:{emailid}`: An email address that represents a specific Google
# account. For example, `alice@example.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
# account. For example, `my-other-app@appspot.gserviceaccount.com`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
# * `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.
#
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
&quot;A String&quot;,
],
&quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
&quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # 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 members 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).
# 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: &quot;Summary size limit&quot;
# description: &quot;Determines if a summary is less than 100 chars&quot;
# expression: &quot;document.summary.size() &lt; 100&quot;
#
# Example (Equality):
#
# title: &quot;Requestor is owner&quot;
# description: &quot;Determines if requestor is the document owner&quot;
# expression: &quot;document.owner == request.auth.claims.email&quot;
#
# Example (Logic):
#
# title: &quot;Public documents&quot;
# description: &quot;Determine whether the document should be publicly visible&quot;
# expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
#
# Example (Data Manipulation):
#
# title: &quot;Notification string&quot;
# description: &quot;Create a notification string with a timestamp.&quot;
# expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
#
# 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.
&quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
&quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
&quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
# syntax.
&quot;title&quot;: &quot;A String&quot;, # 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.
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(name, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists every ServiceAccount that belongs to a specific project.
Args:
name: string, Required. The resource name of the project associated with the service
accounts, such as `projects/my-project-123`. (required)
pageSize: integer, 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: string, Optional pagination token returned in an earlier
ListServiceAccountsResponse.next_page_token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The service account list response.
&quot;nextPageToken&quot;: &quot;A String&quot;, # To retrieve the next page of results, set
# ListServiceAccountsRequest.page_token
# to this value.
&quot;accounts&quot;: [ # The list of matching service accounts.
{ # 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.
&quot;disabled&quot;: True or False, # Output only. Whether the service account is disabled.
&quot;uniqueId&quot;: &quot;A String&quot;, # 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.
&quot;projectId&quot;: &quot;A String&quot;, # Output only. The ID of the project that owns the service account.
&quot;etag&quot;: &quot;A String&quot;, # Deprecated. Do not use.
&quot;email&quot;: &quot;A String&quot;, # Output only. The email address of the service account.
&quot;name&quot;: &quot;A String&quot;, # 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 get 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.
&quot;displayName&quot;: &quot;A String&quot;, # Optional. A user-specified, human-readable name for the service account. The maximum
# length is 100 UTF-8 bytes.
&quot;oauth2ClientId&quot;: &quot;A String&quot;, # Output only. The OAuth 2.0 client ID for the service account.
&quot;description&quot;: &quot;A String&quot;, # Optional. A user-specified, human-readable description of the service account. The
# maximum length is 256 UTF-8 bytes.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>
<pre>Patches a ServiceAccount.
Args:
name: string, 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 get 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. (required)
body: object, The request body.
The object takes the form of:
{ # The request for
# PatchServiceAccount.
#
# You can patch only the `display_name` and `description` fields. You must use
# the `update_mask` field to specify which of these fields you want to patch.
#
# Only the fields specified in the request are guaranteed to be returned in
# the response. Other fields may be empty in the response.
&quot;serviceAccount&quot;: { # 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.
&quot;disabled&quot;: True or False, # Output only. Whether the service account is disabled.
&quot;uniqueId&quot;: &quot;A String&quot;, # 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.
&quot;projectId&quot;: &quot;A String&quot;, # Output only. The ID of the project that owns the service account.
&quot;etag&quot;: &quot;A String&quot;, # Deprecated. Do not use.
&quot;email&quot;: &quot;A String&quot;, # Output only. The email address of the service account.
&quot;name&quot;: &quot;A String&quot;, # 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 get 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.
&quot;displayName&quot;: &quot;A String&quot;, # Optional. A user-specified, human-readable name for the service account. The maximum
# length is 100 UTF-8 bytes.
&quot;oauth2ClientId&quot;: &quot;A String&quot;, # Output only. The OAuth 2.0 client ID for the service account.
&quot;description&quot;: &quot;A String&quot;, # Optional. A user-specified, human-readable description of the service account. The
# maximum length is 256 UTF-8 bytes.
},
&quot;updateMask&quot;: &quot;A String&quot;,
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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.
&quot;disabled&quot;: True or False, # Output only. Whether the service account is disabled.
&quot;uniqueId&quot;: &quot;A String&quot;, # 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.
&quot;projectId&quot;: &quot;A String&quot;, # Output only. The ID of the project that owns the service account.
&quot;etag&quot;: &quot;A String&quot;, # Deprecated. Do not use.
&quot;email&quot;: &quot;A String&quot;, # Output only. The email address of the service account.
&quot;name&quot;: &quot;A String&quot;, # 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 get 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.
&quot;displayName&quot;: &quot;A String&quot;, # Optional. A user-specified, human-readable name for the service account. The maximum
# length is 100 UTF-8 bytes.
&quot;oauth2ClientId&quot;: &quot;A String&quot;, # Output only. The OAuth 2.0 client ID for the service account.
&quot;description&quot;: &quot;A String&quot;, # Optional. A user-specified, human-readable description of the service account. The
# maximum length is 256 UTF-8 bytes.
}</pre>
</div>
<div class="method">
<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
<pre>Sets the IAM policy that is attached to a ServiceAccount.
Use this method to grant or revoke access to the service account. For
example, you could grant a member the ability to impersonate the service
account.
This method does not enable the service account to access other resources.
To grant roles to a service account on a resource, follow these steps:
1. Call the resource&#x27;s `getIamPolicy` method to get its current IAM policy.
2. Edit the policy so that it binds the service account to an IAM role for
the resource.
3. Call the resource&#x27;s `setIamPolicy` method to update its IAM policy.
For detailed instructions, see
[Granting roles to a service account for specific
resources](https://cloud.google.com/iam/help/service-accounts/granting-access-to-service-accounts).
Args:
resource: string, REQUIRED: The resource for which the policy is being specified.
See the operation documentation for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
&quot;policy&quot;: { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
# the policy is limited to a few 10s of KB. An empty policy is a
# valid policy but certain Cloud Platform services (such as Projects)
# might reject them.
# controls for Google Cloud resources.
#
#
# A `Policy` is a collection of `bindings`. A `binding` binds one or more
# `members` to a single `role`. Members 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:**
#
# {
# &quot;bindings&quot;: [
# {
# &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
# &quot;members&quot;: [
# &quot;user:mike@example.com&quot;,
# &quot;group:admins@example.com&quot;,
# &quot;domain:google.com&quot;,
# &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot;
# ]
# },
# {
# &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
# &quot;members&quot;: [
# &quot;user:eve@example.com&quot;
# ],
# &quot;condition&quot;: {
# &quot;title&quot;: &quot;expirable access&quot;,
# &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
# &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
# }
# }
# ],
# &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
# &quot;version&quot;: 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 &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
&quot;etag&quot;: &quot;A String&quot;, # `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.
&quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
# The configuration determines which permission types are logged, and what
# identities, if any, are exempted from logging.
# An AuditConfig must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
# the union of the two AuditConfigs is used for that service: the log_types
# specified in each AuditConfig are enabled, and the exempted_members in each
# AuditLogConfig are exempted.
#
# Example Policy with multiple AuditConfigs:
#
# {
# &quot;audit_configs&quot;: [
# {
# &quot;service&quot;: &quot;allServices&quot;,
# &quot;audit_log_configs&quot;: [
# {
# &quot;log_type&quot;: &quot;DATA_READ&quot;,
# &quot;exempted_members&quot;: [
# &quot;user:jose@example.com&quot;
# ]
# },
# {
# &quot;log_type&quot;: &quot;DATA_WRITE&quot;
# },
# {
# &quot;log_type&quot;: &quot;ADMIN_READ&quot;
# }
# ]
# },
# {
# &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
# &quot;audit_log_configs&quot;: [
# {
# &quot;log_type&quot;: &quot;DATA_READ&quot;
# },
# {
# &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
# &quot;exempted_members&quot;: [
# &quot;user:aliya@example.com&quot;
# ]
# }
# ]
# }
# ]
# }
#
# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
# logging. It also exempts jose@example.com from DATA_READ logging, and
# aliya@example.com from DATA_WRITE logging.
&quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions.
# Example:
#
# {
# &quot;audit_log_configs&quot;: [
# {
# &quot;log_type&quot;: &quot;DATA_READ&quot;,
# &quot;exempted_members&quot;: [
# &quot;user:jose@example.com&quot;
# ]
# },
# {
# &quot;log_type&quot;: &quot;DATA_WRITE&quot;
# }
# ]
# }
#
# This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
# jose@example.com from DATA_READ logging.
&quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
&quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
# permission.
# Follows the same format of Binding.members.
&quot;A String&quot;,
],
},
],
&quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
&quot;version&quot;: 42, # 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).
&quot;bindings&quot;: [ # Associates a list of `members` to 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 member.
{ # Associates `members` with a `role`.
&quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform 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.
#
# * `user:{emailid}`: An email address that represents a specific Google
# account. For example, `alice@example.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
# account. For example, `my-other-app@appspot.gserviceaccount.com`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
# * `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.
#
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
&quot;A String&quot;,
],
&quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
&quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # 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 members 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).
# 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: &quot;Summary size limit&quot;
# description: &quot;Determines if a summary is less than 100 chars&quot;
# expression: &quot;document.summary.size() &lt; 100&quot;
#
# Example (Equality):
#
# title: &quot;Requestor is owner&quot;
# description: &quot;Determines if requestor is the document owner&quot;
# expression: &quot;document.owner == request.auth.claims.email&quot;
#
# Example (Logic):
#
# title: &quot;Public documents&quot;
# description: &quot;Determine whether the document should be publicly visible&quot;
# expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
#
# Example (Data Manipulation):
#
# title: &quot;Notification string&quot;
# description: &quot;Create a notification string with a timestamp.&quot;
# expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
#
# 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.
&quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
&quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
&quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
# syntax.
&quot;title&quot;: &quot;A String&quot;, # 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.
},
},
],
},
&quot;updateMask&quot;: &quot;A String&quot;, # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
# the fields in the mask will be modified. If no mask is provided, the
# following default mask is used:
#
# `paths: &quot;bindings, etag&quot;`
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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` to a single `role`. Members 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:**
#
# {
# &quot;bindings&quot;: [
# {
# &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
# &quot;members&quot;: [
# &quot;user:mike@example.com&quot;,
# &quot;group:admins@example.com&quot;,
# &quot;domain:google.com&quot;,
# &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot;
# ]
# },
# {
# &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
# &quot;members&quot;: [
# &quot;user:eve@example.com&quot;
# ],
# &quot;condition&quot;: {
# &quot;title&quot;: &quot;expirable access&quot;,
# &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
# &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
# }
# }
# ],
# &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
# &quot;version&quot;: 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 &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
&quot;etag&quot;: &quot;A String&quot;, # `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.
&quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
# The configuration determines which permission types are logged, and what
# identities, if any, are exempted from logging.
# An AuditConfig must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
# the union of the two AuditConfigs is used for that service: the log_types
# specified in each AuditConfig are enabled, and the exempted_members in each
# AuditLogConfig are exempted.
#
# Example Policy with multiple AuditConfigs:
#
# {
# &quot;audit_configs&quot;: [
# {
# &quot;service&quot;: &quot;allServices&quot;,
# &quot;audit_log_configs&quot;: [
# {
# &quot;log_type&quot;: &quot;DATA_READ&quot;,
# &quot;exempted_members&quot;: [
# &quot;user:jose@example.com&quot;
# ]
# },
# {
# &quot;log_type&quot;: &quot;DATA_WRITE&quot;
# },
# {
# &quot;log_type&quot;: &quot;ADMIN_READ&quot;
# }
# ]
# },
# {
# &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
# &quot;audit_log_configs&quot;: [
# {
# &quot;log_type&quot;: &quot;DATA_READ&quot;
# },
# {
# &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
# &quot;exempted_members&quot;: [
# &quot;user:aliya@example.com&quot;
# ]
# }
# ]
# }
# ]
# }
#
# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
# logging. It also exempts jose@example.com from DATA_READ logging, and
# aliya@example.com from DATA_WRITE logging.
&quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions.
# Example:
#
# {
# &quot;audit_log_configs&quot;: [
# {
# &quot;log_type&quot;: &quot;DATA_READ&quot;,
# &quot;exempted_members&quot;: [
# &quot;user:jose@example.com&quot;
# ]
# },
# {
# &quot;log_type&quot;: &quot;DATA_WRITE&quot;
# }
# ]
# }
#
# This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
# jose@example.com from DATA_READ logging.
&quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
&quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
# permission.
# Follows the same format of Binding.members.
&quot;A String&quot;,
],
},
],
&quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
&quot;version&quot;: 42, # 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).
&quot;bindings&quot;: [ # Associates a list of `members` to 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 member.
{ # Associates `members` with a `role`.
&quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform 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.
#
# * `user:{emailid}`: An email address that represents a specific Google
# account. For example, `alice@example.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
# account. For example, `my-other-app@appspot.gserviceaccount.com`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
# * `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.
#
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
&quot;A String&quot;,
],
&quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
&quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # 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 members 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).
# 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: &quot;Summary size limit&quot;
# description: &quot;Determines if a summary is less than 100 chars&quot;
# expression: &quot;document.summary.size() &lt; 100&quot;
#
# Example (Equality):
#
# title: &quot;Requestor is owner&quot;
# description: &quot;Determines if requestor is the document owner&quot;
# expression: &quot;document.owner == request.auth.claims.email&quot;
#
# Example (Logic):
#
# title: &quot;Public documents&quot;
# description: &quot;Determine whether the document should be publicly visible&quot;
# expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
#
# Example (Data Manipulation):
#
# title: &quot;Notification string&quot;
# description: &quot;Create a notification string with a timestamp.&quot;
# expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
#
# 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.
&quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
&quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
&quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
# syntax.
&quot;title&quot;: &quot;A String&quot;, # 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.
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="signBlob">signBlob(name, body=None, x__xgafv=None)</code>
<pre>**Note:** This method is deprecated and will stop working on July 1, 2021.
Use the
[`signBlob`](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signBlob)
method in the IAM Service Account Credentials API instead. If you currently
use this method, see the [migration
guide](https://cloud.google.com/iam/help/credentials/migrate-api) for
instructions.
Signs a blob using the system-managed private key for a ServiceAccount.
Args:
name: string, Required. Deprecated. [Migrate to Service Account Credentials
API](https://cloud.google.com/iam/help/credentials/migrate-api).
The resource name of the service account in the following format:
`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
Using `-` as a wildcard for the `PROJECT_ID` will infer the project from
the account. The `ACCOUNT` value can be the `email` address or the
`unique_id` of the service account. (required)
body: object, The request body.
The object takes the form of:
{ # Deprecated. [Migrate to Service Account Credentials
# API](https://cloud.google.com/iam/help/credentials/migrate-api).
#
# The service account sign blob request.
&quot;bytesToSign&quot;: &quot;A String&quot;, # Required. Deprecated. [Migrate to Service Account Credentials
# API](https://cloud.google.com/iam/help/credentials/migrate-api).
#
# The bytes to sign.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Deprecated. [Migrate to Service Account Credentials
# API](https://cloud.google.com/iam/help/credentials/migrate-api).
#
# The service account sign blob response.
&quot;signature&quot;: &quot;A String&quot;, # Deprecated. [Migrate to Service Account Credentials
# API](https://cloud.google.com/iam/help/credentials/migrate-api).
#
# The signed blob.
&quot;keyId&quot;: &quot;A String&quot;, # Deprecated. [Migrate to Service Account Credentials
# API](https://cloud.google.com/iam/help/credentials/migrate-api).
#
# The id of the key used to sign the blob.
}</pre>
</div>
<div class="method">
<code class="details" id="signJwt">signJwt(name, body=None, x__xgafv=None)</code>
<pre>**Note:** This method is deprecated and will stop working on July 1, 2021.
Use the
[`signJwt`](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signJwt)
method in the IAM Service Account Credentials API instead. If you currently
use this method, see the [migration
guide](https://cloud.google.com/iam/help/credentials/migrate-api) for
instructions.
Signs a JSON Web Token (JWT) using the system-managed private key for a
ServiceAccount.
Args:
name: string, Required. Deprecated. [Migrate to Service Account Credentials
API](https://cloud.google.com/iam/help/credentials/migrate-api).
The resource name of the service account in the following format:
`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
Using `-` as a wildcard for the `PROJECT_ID` will infer the project from
the account. The `ACCOUNT` value can be the `email` address or the
`unique_id` of the service account. (required)
body: object, The request body.
The object takes the form of:
{ # Deprecated. [Migrate to Service Account Credentials
# API](https://cloud.google.com/iam/help/credentials/migrate-api).
#
# The service account sign JWT request.
&quot;payload&quot;: &quot;A String&quot;, # Required. Deprecated. [Migrate to Service Account Credentials
# API](https://cloud.google.com/iam/help/credentials/migrate-api).
#
# The JWT payload to sign. Must be a serialized JSON object that contains a
# JWT Claims Set. For example: `{&quot;sub&quot;: &quot;user@example.com&quot;, &quot;iat&quot;: 313435}`
#
# If the JWT Claims Set contains an expiration time (`exp`) claim, it must be
# an integer timestamp that is not in the past and no more than 1 hour in the
# future.
#
# If the JWT Claims Set does not contain an expiration time (`exp`) claim,
# this claim is added automatically, with a timestamp that is 1 hour in the
# future.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Deprecated. [Migrate to Service Account Credentials
# API](https://cloud.google.com/iam/help/credentials/migrate-api).
#
# The service account sign JWT response.
&quot;signedJwt&quot;: &quot;A String&quot;, # Deprecated. [Migrate to Service Account Credentials
# API](https://cloud.google.com/iam/help/credentials/migrate-api).
#
# The signed JWT.
&quot;keyId&quot;: &quot;A String&quot;, # Deprecated. [Migrate to Service Account Credentials
# API](https://cloud.google.com/iam/help/credentials/migrate-api).
#
# The id of the key used to sign the JWT.
}</pre>
</div>
<div class="method">
<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
<pre>Tests whether the caller has the specified permissions on a
ServiceAccount.
Args:
resource: string, REQUIRED: The resource for which the policy detail is being requested.
See the operation documentation for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
&quot;permissions&quot;: [ # The set of permissions to check for the `resource`. Permissions with
# wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed. For more
# information see
# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
&quot;A String&quot;,
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for `TestIamPermissions` method.
&quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
# allowed.
&quot;A String&quot;,
],
}</pre>
</div>
<div class="method">
<code class="details" id="undelete">undelete(name, body=None, x__xgafv=None)</code>
<pre>Restores a deleted ServiceAccount.
**Important:** It is not always possible to restore a deleted service
account. Use this method only as a last resort.
After you delete a service account, IAM permanently removes the service
account 30 days later. There is no way to restore a deleted service account
that has been permanently removed.
Args:
name: string, The resource name of the service account in the following format:
`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_UNIQUE_ID}`.
Using `-` as a wildcard for the `PROJECT_ID` will infer the project from
the account. (required)
body: object, The request body.
The object takes the form of:
{ # The service account undelete request.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
&quot;restoredAccount&quot;: { # An IAM service account. # Metadata for the restored 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.
&quot;disabled&quot;: True or False, # Output only. Whether the service account is disabled.
&quot;uniqueId&quot;: &quot;A String&quot;, # 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.
&quot;projectId&quot;: &quot;A String&quot;, # Output only. The ID of the project that owns the service account.
&quot;etag&quot;: &quot;A String&quot;, # Deprecated. Do not use.
&quot;email&quot;: &quot;A String&quot;, # Output only. The email address of the service account.
&quot;name&quot;: &quot;A String&quot;, # 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 get 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.
&quot;displayName&quot;: &quot;A String&quot;, # Optional. A user-specified, human-readable name for the service account. The maximum
# length is 100 UTF-8 bytes.
&quot;oauth2ClientId&quot;: &quot;A String&quot;, # Output only. The OAuth 2.0 client ID for the service account.
&quot;description&quot;: &quot;A String&quot;, # Optional. A user-specified, human-readable description of the service account. The
# maximum length is 256 UTF-8 bytes.
},
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
<pre>**Note:** We are in the process of deprecating this method. Use
PatchServiceAccount instead.
Updates a ServiceAccount.
You can update only the `display_name` and `description` fields.
Args:
name: string, 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 get 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. (required)
body: object, The request body.
The object takes the form of:
{ # 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.
&quot;disabled&quot;: True or False, # Output only. Whether the service account is disabled.
&quot;uniqueId&quot;: &quot;A String&quot;, # 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.
&quot;projectId&quot;: &quot;A String&quot;, # Output only. The ID of the project that owns the service account.
&quot;etag&quot;: &quot;A String&quot;, # Deprecated. Do not use.
&quot;email&quot;: &quot;A String&quot;, # Output only. The email address of the service account.
&quot;name&quot;: &quot;A String&quot;, # 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 get 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.
&quot;displayName&quot;: &quot;A String&quot;, # Optional. A user-specified, human-readable name for the service account. The maximum
# length is 100 UTF-8 bytes.
&quot;oauth2ClientId&quot;: &quot;A String&quot;, # Output only. The OAuth 2.0 client ID for the service account.
&quot;description&quot;: &quot;A String&quot;, # Optional. A user-specified, human-readable description of the service account. The
# maximum length is 256 UTF-8 bytes.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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.
&quot;disabled&quot;: True or False, # Output only. Whether the service account is disabled.
&quot;uniqueId&quot;: &quot;A String&quot;, # 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.
&quot;projectId&quot;: &quot;A String&quot;, # Output only. The ID of the project that owns the service account.
&quot;etag&quot;: &quot;A String&quot;, # Deprecated. Do not use.
&quot;email&quot;: &quot;A String&quot;, # Output only. The email address of the service account.
&quot;name&quot;: &quot;A String&quot;, # 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 get 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.
&quot;displayName&quot;: &quot;A String&quot;, # Optional. A user-specified, human-readable name for the service account. The maximum
# length is 100 UTF-8 bytes.
&quot;oauth2ClientId&quot;: &quot;A String&quot;, # Output only. The OAuth 2.0 client ID for the service account.
&quot;description&quot;: &quot;A String&quot;, # Optional. A user-specified, human-readable description of the service account. The
# maximum length is 256 UTF-8 bytes.
}</pre>
</div>
</body></html>