Google Git
Sign in
android / platform / external / python / google-api-python-client / refs/heads/android11-dev / . / docs / dyn / iam_v1.projects.serviceAccounts.html
blob: fda208d19965e118096fdaeb47091c223ffcfd24 [file] [log] [blame] [edit]
<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, 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">DisableServiceAccount is currently in the alpha launch stage.</p>
<p class="toc_element">
<code><a href="#enable">enable(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">EnableServiceAccount is currently in the alpha launch stage.</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, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the Cloud IAM access control policy for a</p>
<p class="toc_element">
<code><a href="#list">list(name, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
<p class="firstline">Lists ServiceAccounts for a 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, x__xgafv=None)</a></code></p>
<p class="firstline">Patches a ServiceAccount.</p>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the Cloud IAM access control policy for a</p>
<p class="toc_element">
<code><a href="#signBlob">signBlob(name, body, x__xgafv=None)</a></code></p>
<p class="firstline">**Note**: This method is in the process of being deprecated. Call the</p>
<p class="toc_element">
<code><a href="#signJwt">signJwt(name, body, x__xgafv=None)</a></code></p>
<p class="firstline">**Note**: This method is in the process of being deprecated. Call the</p>
<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
<p class="firstline">Tests the specified permissions against the IAM access control policy</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, x__xgafv=None)</a></code></p>
<p class="firstline">Note: This method is in the process of being deprecated. Use</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(name, body, x__xgafv=None)</code>
<pre>Creates a ServiceAccount
and returns it.
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. (required)
The object takes the form of:
{ # The service account create request.
"serviceAccount": { # A service account in the Identity and Access Management API. # The ServiceAccount resource to
# create. Currently, only the following values are user assignable:
# `display_name` .
#
# To create a service account, specify the `project_id` and the `account_id`
# for the account. The `account_id` is unique within the project, and is used
# to generate the service account email address and a stable
# `unique_id`.
#
# If the account already exists, the account's resource name is returned
# in the format of projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. The caller
# can use the name in other methods to access the account.
#
# All other methods can identify the service account using the 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.
"oauth2ClientId": "A String", # @OutputOnly The OAuth2 client id for the service account.
# This is used in conjunction with the OAuth2 clientconfig API to make
# three legged OAuth2 (3LO) flows to access the data of Google users.
"displayName": "A String", # Optional. A user-specified name for the service account.
# Must be less than or equal to 100 UTF-8 bytes.
"description": "A String", # Optional. A user-specified opaque description of the service account.
# Must be less than or equal to 256 UTF-8 bytes.
"projectId": "A String", # @OutputOnly The id of the project that owns the service account.
"disabled": True or False, # @OutputOnly A bool indicate if the service account is disabled.
# The field is currently in alpha phase.
"etag": "A String", # Optional. Note: `etag` is an inoperable legacy field that is only returned
# for backwards compatibility.
"uniqueId": "A String", # @OutputOnly The unique and stable id of the service account.
"email": "A String", # @OutputOnly The email address of the service account.
"name": "A String", # The resource name of the service account in the following format:
# `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
#
# Requests using `-` as a wildcard for the `PROJECT_ID` will infer the
# project from the `account` and the `ACCOUNT` value can be the `email`
# address or the `unique_id` of the service account.
#
# In responses the resource name will always be in the format
# `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
},
"accountId": "A String", # 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.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A service account in the Identity and Access Management API.
#
# To create a service account, specify the `project_id` and the `account_id`
# for the account. The `account_id` is unique within the project, and is used
# to generate the service account email address and a stable
# `unique_id`.
#
# If the account already exists, the account's resource name is returned
# in the format of projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. The caller
# can use the name in other methods to access the account.
#
# All other methods can identify the service account using the 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.
"oauth2ClientId": "A String", # @OutputOnly The OAuth2 client id for the service account.
# This is used in conjunction with the OAuth2 clientconfig API to make
# three legged OAuth2 (3LO) flows to access the data of Google users.
"displayName": "A String", # Optional. A user-specified name for the service account.
# Must be less than or equal to 100 UTF-8 bytes.
"description": "A String", # Optional. A user-specified opaque description of the service account.
# Must be less than or equal to 256 UTF-8 bytes.
"projectId": "A String", # @OutputOnly The id of the project that owns the service account.
"disabled": True or False, # @OutputOnly A bool indicate if the service account is disabled.
# The field is currently in alpha phase.
"etag": "A String", # Optional. Note: `etag` is an inoperable legacy field that is only returned
# for backwards compatibility.
"uniqueId": "A String", # @OutputOnly The unique and stable id of the service account.
"email": "A String", # @OutputOnly The email address of the service account.
"name": "A String", # The resource name of the service account in the following format:
# `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
#
# Requests using `-` as a wildcard for the `PROJECT_ID` will infer the
# project from the `account` and the `ACCOUNT` value can be the `email`
# address or the `unique_id` of the service account.
#
# In responses the resource name will always be in the format
# `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a ServiceAccount.
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)
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>DisableServiceAccount is currently in the alpha launch stage.
Disables a ServiceAccount,
which immediately prevents the service account from authenticating and
gaining access to APIs.
Disabled service accounts can be safely restored by using
EnableServiceAccount at any point. Deleted service accounts cannot be
restored using this method.
Disabling a service account that is bound to VMs, Apps, Functions, or
other jobs will cause those jobs to lose access to resources if they are
using the disabled service account.
To improve reliability of your services and avoid unexpected outages, it
is recommended to first disable a service account rather than delete it.
After disabling the service account, wait at least 24 hours to verify there
are no unintended consequences, and then delete 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 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>EnableServiceAccount is currently in the alpha launch stage.
Restores a disabled ServiceAccount
that has been manually disabled by using DisableServiceAccount. Service
accounts that have been disabled by other means or for other reasons,
such as abuse, cannot be restored using this method.
EnableServiceAccount will have no effect on a service account that is
not disabled. Enabling an already enabled service account will have no
effect.
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 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, 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 service account in the Identity and Access Management API.
#
# To create a service account, specify the `project_id` and the `account_id`
# for the account. The `account_id` is unique within the project, and is used
# to generate the service account email address and a stable
# `unique_id`.
#
# If the account already exists, the account's resource name is returned
# in the format of projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. The caller
# can use the name in other methods to access the account.
#
# All other methods can identify the service account using the 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.
"oauth2ClientId": "A String", # @OutputOnly The OAuth2 client id for the service account.
# This is used in conjunction with the OAuth2 clientconfig API to make
# three legged OAuth2 (3LO) flows to access the data of Google users.
"displayName": "A String", # Optional. A user-specified name for the service account.
# Must be less than or equal to 100 UTF-8 bytes.
"description": "A String", # Optional. A user-specified opaque description of the service account.
# Must be less than or equal to 256 UTF-8 bytes.
"projectId": "A String", # @OutputOnly The id of the project that owns the service account.
"disabled": True or False, # @OutputOnly A bool indicate if the service account is disabled.
# The field is currently in alpha phase.
"etag": "A String", # Optional. Note: `etag` is an inoperable legacy field that is only returned
# for backwards compatibility.
"uniqueId": "A String", # @OutputOnly The unique and stable id of the service account.
"email": "A String", # @OutputOnly The email address of the service account.
"name": "A String", # The resource name of the service account in the following format:
# `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
#
# Requests using `-` as a wildcard for the `PROJECT_ID` will infer the
# project from the `account` and the `ACCOUNT` value can be the `email`
# address or the `unique_id` of the service account.
#
# In responses the resource name will always be in the format
# `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
}</pre>
</div>
<div class="method">
<code class="details" id="getIamPolicy">getIamPolicy(resource, x__xgafv=None)</code>
<pre>Returns the Cloud IAM access control policy for a
ServiceAccount.
Note: Service accounts are both
[resources and
identities](/iam/docs/service-accounts#service_account_permissions). This
method treats the service account as a resource. It returns the Cloud IAM
policy that reflects what members have access to the service account.
This method does not return what resources the service account has access
to. To see if a service account has access to a resource, call the
`getIamPolicy` method on the target resource. For example, to view grants
for a project, call the
[projects.getIamPolicy](/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)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Defines an Identity and Access Management (IAM) policy. It is used to
# specify access control policies for Cloud Platform resources.
#
#
# A `Policy` consists of a list of `bindings`. A `binding` binds a list of
# `members` to a `role`, where the members can be user accounts, Google groups,
# Google domains, and service accounts. A `role` is a named list of permissions
# defined by IAM.
#
# **JSON Example**
#
# {
# "bindings": [
# {
# "role": "roles/owner",
# "members": [
# "user:[email protected]",
# "group:[email protected]",
# "domain:google.com",
# "serviceAccount:[email protected]"
# ]
# },
# {
# "role": "roles/viewer",
# "members": ["user:[email protected]"]
# }
# ]
# }
#
# **YAML Example**
#
# bindings:
# - members:
# - user:[email protected]
# - group:[email protected]
# - domain:google.com
# - serviceAccount:[email protected]
# role: roles/owner
# - members:
# - user:[email protected]
# role: roles/viewer
#
#
# For a description of IAM and its features, see the
# [IAM developer's guide](https://cloud.google.com/iam/docs).
"bindings": [ # Associates a list of `members` to a `role`.
# `bindings` with no members will result in an error.
{ # Associates `members` with a `role`.
"role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
"members": [ # 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, `[email protected]` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
# account. For example, `[email protected]`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `[email protected]`.
#
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
"A String",
],
"condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
# NOTE: An unsatisfied condition will not allow user access via current
# binding. Different bindings, including their conditions, are examined
# independently.
#
# title: "User account presence"
# description: "Determines whether the request has a user account"
# expression: "size(request.user) > 0"
"location": "A String", # An optional string indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
"expression": "A String", # Textual representation of an expression in
# Common Expression Language syntax.
#
# The application context of the containing message determines which
# well-known feature set of CEL is supported.
"description": "A String", # An optional description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
"title": "A String", # An 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.
},
},
],
"auditConfigs": [ # 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:
#
# {
# "audit_configs": [
# {
# "service": "allServices"
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:[email protected]"
# ]
# },
# {
# "log_type": "DATA_WRITE",
# },
# {
# "log_type": "ADMIN_READ",
# }
# ]
# },
# {
# "service": "fooservice.googleapis.com"
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# },
# {
# "log_type": "DATA_WRITE",
# "exempted_members": [
# "user:[email protected]"
# ]
# }
# ]
# }
# ]
# }
#
# For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
# logging. It also exempts [email protected] from DATA_READ logging, and
# [email protected] from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions.
# Example:
#
# {
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:[email protected]"
# ]
# },
# {
# "log_type": "DATA_WRITE",
# }
# ]
# }
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
# [email protected] from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
# permission.
# Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # 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.
},
],
"etag": "A String", # `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.
#
# If no `etag` is provided in the call to `setIamPolicy`, then the existing
# policy is overwritten blindly.
"version": 42, # Deprecated.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None)</code>
<pre>Lists ServiceAccounts for a project.
Args:
name: string, Required. The resource name of the project associated with the service
accounts, such as `projects/my-project-123`. (required)
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
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.
Returns:
An object of the form:
{ # The service account list response.
"nextPageToken": "A String", # To retrieve the next page of results, set
# ListServiceAccountsRequest.page_token
# to this value.
"accounts": [ # The list of matching service accounts.
{ # A service account in the Identity and Access Management API.
#
# To create a service account, specify the `project_id` and the `account_id`
# for the account. The `account_id` is unique within the project, and is used
# to generate the service account email address and a stable
# `unique_id`.
#
# If the account already exists, the account's resource name is returned
# in the format of projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. The caller
# can use the name in other methods to access the account.
#
# All other methods can identify the service account using the 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.
"oauth2ClientId": "A String", # @OutputOnly The OAuth2 client id for the service account.
# This is used in conjunction with the OAuth2 clientconfig API to make
# three legged OAuth2 (3LO) flows to access the data of Google users.
"displayName": "A String", # Optional. A user-specified name for the service account.
# Must be less than or equal to 100 UTF-8 bytes.
"description": "A String", # Optional. A user-specified opaque description of the service account.
# Must be less than or equal to 256 UTF-8 bytes.
"projectId": "A String", # @OutputOnly The id of the project that owns the service account.
"disabled": True or False, # @OutputOnly A bool indicate if the service account is disabled.
# The field is currently in alpha phase.
"etag": "A String", # Optional. Note: `etag` is an inoperable legacy field that is only returned
# for backwards compatibility.
"uniqueId": "A String", # @OutputOnly The unique and stable id of the service account.
"email": "A String", # @OutputOnly The email address of the service account.
"name": "A String", # The resource name of the service account in the following format:
# `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
#
# Requests using `-` as a wildcard for the `PROJECT_ID` will infer the
# project from the `account` and the `ACCOUNT` value can be the `email`
# address or the `unique_id` of the service account.
#
# In responses the resource name will always be in the format
# `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
},
],
}</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 'execute()' 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, x__xgafv=None)</code>
<pre>Patches a ServiceAccount.
Currently, only the following fields are updatable:
`display_name` and `description`.
Only fields specified in the request are guaranteed to be returned in
the response. Other fields in the response may be empty.
Note: The field mask is required.
Args:
name: string, The resource name of the service account in the following format:
`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
Requests using `-` as a wildcard for the `PROJECT_ID` will infer the
project from the `account` and the `ACCOUNT` value can be the `email`
address or the `unique_id` of the service account.
In responses the resource name will always be in the format
`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. (required)
body: object, The request body. (required)
The object takes the form of:
{ # The patch service account request.
"serviceAccount": { # A service account in the Identity and Access Management API.
#
# To create a service account, specify the `project_id` and the `account_id`
# for the account. The `account_id` is unique within the project, and is used
# to generate the service account email address and a stable
# `unique_id`.
#
# If the account already exists, the account's resource name is returned
# in the format of projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. The caller
# can use the name in other methods to access the account.
#
# All other methods can identify the service account using the 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.
"oauth2ClientId": "A String", # @OutputOnly The OAuth2 client id for the service account.
# This is used in conjunction with the OAuth2 clientconfig API to make
# three legged OAuth2 (3LO) flows to access the data of Google users.
"displayName": "A String", # Optional. A user-specified name for the service account.
# Must be less than or equal to 100 UTF-8 bytes.
"description": "A String", # Optional. A user-specified opaque description of the service account.
# Must be less than or equal to 256 UTF-8 bytes.
"projectId": "A String", # @OutputOnly The id of the project that owns the service account.
"disabled": True or False, # @OutputOnly A bool indicate if the service account is disabled.
# The field is currently in alpha phase.
"etag": "A String", # Optional. Note: `etag` is an inoperable legacy field that is only returned
# for backwards compatibility.
"uniqueId": "A String", # @OutputOnly The unique and stable id of the service account.
"email": "A String", # @OutputOnly The email address of the service account.
"name": "A String", # The resource name of the service account in the following format:
# `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
#
# Requests using `-` as a wildcard for the `PROJECT_ID` will infer the
# project from the `account` and the `ACCOUNT` value can be the `email`
# address or the `unique_id` of the service account.
#
# In responses the resource name will always be in the format
# `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
},
"updateMask": "A String",
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A service account in the Identity and Access Management API.
#
# To create a service account, specify the `project_id` and the `account_id`
# for the account. The `account_id` is unique within the project, and is used
# to generate the service account email address and a stable
# `unique_id`.
#
# If the account already exists, the account's resource name is returned
# in the format of projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. The caller
# can use the name in other methods to access the account.
#
# All other methods can identify the service account using the 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.
"oauth2ClientId": "A String", # @OutputOnly The OAuth2 client id for the service account.
# This is used in conjunction with the OAuth2 clientconfig API to make
# three legged OAuth2 (3LO) flows to access the data of Google users.
"displayName": "A String", # Optional. A user-specified name for the service account.
# Must be less than or equal to 100 UTF-8 bytes.
"description": "A String", # Optional. A user-specified opaque description of the service account.
# Must be less than or equal to 256 UTF-8 bytes.
"projectId": "A String", # @OutputOnly The id of the project that owns the service account.
"disabled": True or False, # @OutputOnly A bool indicate if the service account is disabled.
# The field is currently in alpha phase.
"etag": "A String", # Optional. Note: `etag` is an inoperable legacy field that is only returned
# for backwards compatibility.
"uniqueId": "A String", # @OutputOnly The unique and stable id of the service account.
"email": "A String", # @OutputOnly The email address of the service account.
"name": "A String", # The resource name of the service account in the following format:
# `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
#
# Requests using `-` as a wildcard for the `PROJECT_ID` will infer the
# project from the `account` and the `ACCOUNT` value can be the `email`
# address or the `unique_id` of the service account.
#
# In responses the resource name will always be in the format
# `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
}</pre>
</div>
<div class="method">
<code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
<pre>Sets the Cloud IAM access control policy for a
ServiceAccount.
Note: Service accounts are both
[resources and
identities](/iam/docs/service-accounts#service_account_permissions). This
method treats the service account as a resource. Use it to grant members
access to the service account, such as when they need to impersonate it.
This method does not grant the service account access to other resources,
such as projects. To grant a service account access to resources, include
the service account in the Cloud IAM policy for the desired resource, then
call the appropriate `setIamPolicy` method on the target resource. For
example, to grant a service account access to a project, call the
[projects.setIamPolicy](/resource-manager/reference/rest/v1/projects/setIamPolicy)
method.
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. (required)
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
"policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # 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.
# specify access control policies for Cloud Platform resources.
#
#
# A `Policy` consists of a list of `bindings`. A `binding` binds a list of
# `members` to a `role`, where the members can be user accounts, Google groups,
# Google domains, and service accounts. A `role` is a named list of permissions
# defined by IAM.
#
# **JSON Example**
#
# {
# "bindings": [
# {
# "role": "roles/owner",
# "members": [
# "user:[email protected]",
# "group:[email protected]",
# "domain:google.com",
# "serviceAccount:[email protected]"
# ]
# },
# {
# "role": "roles/viewer",
# "members": ["user:[email protected]"]
# }
# ]
# }
#
# **YAML Example**
#
# bindings:
# - members:
# - user:[email protected]
# - group:[email protected]
# - domain:google.com
# - serviceAccount:[email protected]
# role: roles/owner
# - members:
# - user:[email protected]
# role: roles/viewer
#
#
# For a description of IAM and its features, see the
# [IAM developer's guide](https://cloud.google.com/iam/docs).
"bindings": [ # Associates a list of `members` to a `role`.
# `bindings` with no members will result in an error.
{ # Associates `members` with a `role`.
"role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
"members": [ # 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, `[email protected]` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
# account. For example, `[email protected]`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `[email protected]`.
#
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
"A String",
],
"condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
# NOTE: An unsatisfied condition will not allow user access via current
# binding. Different bindings, including their conditions, are examined
# independently.
#
# title: "User account presence"
# description: "Determines whether the request has a user account"
# expression: "size(request.user) > 0"
"location": "A String", # An optional string indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
"expression": "A String", # Textual representation of an expression in
# Common Expression Language syntax.
#
# The application context of the containing message determines which
# well-known feature set of CEL is supported.
"description": "A String", # An optional description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
"title": "A String", # An 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.
},
},
],
"auditConfigs": [ # 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:
#
# {
# "audit_configs": [
# {
# "service": "allServices"
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:[email protected]"
# ]
# },
# {
# "log_type": "DATA_WRITE",
# },
# {
# "log_type": "ADMIN_READ",
# }
# ]
# },
# {
# "service": "fooservice.googleapis.com"
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# },
# {
# "log_type": "DATA_WRITE",
# "exempted_members": [
# "user:[email protected]"
# ]
# }
# ]
# }
# ]
# }
#
# For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
# logging. It also exempts [email protected] from DATA_READ logging, and
# [email protected] from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions.
# Example:
#
# {
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:[email protected]"
# ]
# },
# {
# "log_type": "DATA_WRITE",
# }
# ]
# }
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
# [email protected] from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
# permission.
# Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # 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.
},
],
"etag": "A String", # `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.
#
# If no `etag` is provided in the call to `setIamPolicy`, then the existing
# policy is overwritten blindly.
"version": 42, # Deprecated.
},
"updateMask": "A String", # 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: "bindings, etag"
# This field is only used by Cloud IAM.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Defines an Identity and Access Management (IAM) policy. It is used to
# specify access control policies for Cloud Platform resources.
#
#
# A `Policy` consists of a list of `bindings`. A `binding` binds a list of
# `members` to a `role`, where the members can be user accounts, Google groups,
# Google domains, and service accounts. A `role` is a named list of permissions
# defined by IAM.
#
# **JSON Example**
#
# {
# "bindings": [
# {
# "role": "roles/owner",
# "members": [
# "user:[email protected]",
# "group:[email protected]",
# "domain:google.com",
# "serviceAccount:[email protected]"
# ]
# },
# {
# "role": "roles/viewer",
# "members": ["user:[email protected]"]
# }
# ]
# }
#
# **YAML Example**
#
# bindings:
# - members:
# - user:[email protected]
# - group:[email protected]
# - domain:google.com
# - serviceAccount:[email protected]
# role: roles/owner
# - members:
# - user:[email protected]
# role: roles/viewer
#
#
# For a description of IAM and its features, see the
# [IAM developer's guide](https://cloud.google.com/iam/docs).
"bindings": [ # Associates a list of `members` to a `role`.
# `bindings` with no members will result in an error.
{ # Associates `members` with a `role`.
"role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
"members": [ # 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, `[email protected]` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
# account. For example, `[email protected]`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `[email protected]`.
#
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
"A String",
],
"condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
# NOTE: An unsatisfied condition will not allow user access via current
# binding. Different bindings, including their conditions, are examined
# independently.
#
# title: "User account presence"
# description: "Determines whether the request has a user account"
# expression: "size(request.user) > 0"
"location": "A String", # An optional string indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
"expression": "A String", # Textual representation of an expression in
# Common Expression Language syntax.
#
# The application context of the containing message determines which
# well-known feature set of CEL is supported.
"description": "A String", # An optional description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
"title": "A String", # An 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.
},
},
],
"auditConfigs": [ # 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:
#
# {
# "audit_configs": [
# {
# "service": "allServices"
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:[email protected]"
# ]
# },
# {
# "log_type": "DATA_WRITE",
# },
# {
# "log_type": "ADMIN_READ",
# }
# ]
# },
# {
# "service": "fooservice.googleapis.com"
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# },
# {
# "log_type": "DATA_WRITE",
# "exempted_members": [
# "user:[email protected]"
# ]
# }
# ]
# }
# ]
# }
#
# For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
# logging. It also exempts [email protected] from DATA_READ logging, and
# [email protected] from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions.
# Example:
#
# {
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:[email protected]"
# ]
# },
# {
# "log_type": "DATA_WRITE",
# }
# ]
# }
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
# [email protected] from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
# permission.
# Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # 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.
},
],
"etag": "A String", # `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.
#
# If no `etag` is provided in the call to `setIamPolicy`, then the existing
# policy is overwritten blindly.
"version": 42, # Deprecated.
}</pre>
</div>
<div class="method">
<code class="details" id="signBlob">signBlob(name, body, x__xgafv=None)</code>
<pre>**Note**: This method is in the process of being deprecated. Call the
[`signBlob()`](/iam/credentials/reference/rest/v1/projects.serviceAccounts/signBlob)
method of the Cloud IAM Service Account Credentials API instead.
Signs a blob using a service account's system-managed private key.
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. (required)
The object takes the form of:
{ # The service account sign blob request.
"bytesToSign": "A String", # 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:
{ # The service account sign blob response.
"keyId": "A String", # The id of the key used to sign the blob.
"signature": "A String", # The signed blob.
}</pre>
</div>
<div class="method">
<code class="details" id="signJwt">signJwt(name, body, x__xgafv=None)</code>
<pre>**Note**: This method is in the process of being deprecated. Call the
[`signJwt()`](/iam/credentials/reference/rest/v1/projects.serviceAccounts/signJwt)
method of the Cloud IAM Service Account Credentials API instead.
Signs a JWT using a service account's system-managed private key.
If no expiry time (`exp`) is provided in the `SignJwtRequest`, IAM sets an
an expiry time of one hour by default. If you request an expiry time of
more than one hour, the request will fail.
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. (required)
The object takes the form of:
{ # The service account sign JWT request.
"payload": "A String", # The JWT payload to sign, a JSON JWT Claim set.
}
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 sign JWT response.
"keyId": "A String", # The id of the key used to sign the JWT.
"signedJwt": "A String", # The signed JWT.
}</pre>
</div>
<div class="method">
<code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
<pre>Tests the specified permissions against the IAM access control policy
for 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. (required)
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
"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).
"A String",
],
}
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.
"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
# allowed.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="undelete">undelete(name, body=None, x__xgafv=None)</code>
<pre>Restores a deleted ServiceAccount.
This is to be used as an action of last resort. A service account may
not always be restorable.
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:
{
"restoredAccount": { # A service account in the Identity and Access Management API. # Metadata for the restored service account.
#
# To create a service account, specify the `project_id` and the `account_id`
# for the account. The `account_id` is unique within the project, and is used
# to generate the service account email address and a stable
# `unique_id`.
#
# If the account already exists, the account's resource name is returned
# in the format of projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. The caller
# can use the name in other methods to access the account.
#
# All other methods can identify the service account using the 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.
"oauth2ClientId": "A String", # @OutputOnly The OAuth2 client id for the service account.
# This is used in conjunction with the OAuth2 clientconfig API to make
# three legged OAuth2 (3LO) flows to access the data of Google users.
"displayName": "A String", # Optional. A user-specified name for the service account.
# Must be less than or equal to 100 UTF-8 bytes.
"description": "A String", # Optional. A user-specified opaque description of the service account.
# Must be less than or equal to 256 UTF-8 bytes.
"projectId": "A String", # @OutputOnly The id of the project that owns the service account.
"disabled": True or False, # @OutputOnly A bool indicate if the service account is disabled.
# The field is currently in alpha phase.
"etag": "A String", # Optional. Note: `etag` is an inoperable legacy field that is only returned
# for backwards compatibility.
"uniqueId": "A String", # @OutputOnly The unique and stable id of the service account.
"email": "A String", # @OutputOnly The email address of the service account.
"name": "A String", # The resource name of the service account in the following format:
# `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
#
# Requests using `-` as a wildcard for the `PROJECT_ID` will infer the
# project from the `account` and the `ACCOUNT` value can be the `email`
# address or the `unique_id` of the service account.
#
# In responses the resource name will always be in the format
# `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
},
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(name, body, x__xgafv=None)</code>
<pre>Note: This method is in the process of being deprecated. Use
PatchServiceAccount instead.
Updates a ServiceAccount.
Currently, only the following fields are updatable:
`display_name` and `description`.
Args:
name: string, The resource name of the service account in the following format:
`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
Requests using `-` as a wildcard for the `PROJECT_ID` will infer the
project from the `account` and the `ACCOUNT` value can be the `email`
address or the `unique_id` of the service account.
In responses the resource name will always be in the format
`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A service account in the Identity and Access Management API.
#
# To create a service account, specify the `project_id` and the `account_id`
# for the account. The `account_id` is unique within the project, and is used
# to generate the service account email address and a stable
# `unique_id`.
#
# If the account already exists, the account's resource name is returned
# in the format of projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. The caller
# can use the name in other methods to access the account.
#
# All other methods can identify the service account using the 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.
"oauth2ClientId": "A String", # @OutputOnly The OAuth2 client id for the service account.
# This is used in conjunction with the OAuth2 clientconfig API to make
# three legged OAuth2 (3LO) flows to access the data of Google users.
"displayName": "A String", # Optional. A user-specified name for the service account.
# Must be less than or equal to 100 UTF-8 bytes.
"description": "A String", # Optional. A user-specified opaque description of the service account.
# Must be less than or equal to 256 UTF-8 bytes.
"projectId": "A String", # @OutputOnly The id of the project that owns the service account.
"disabled": True or False, # @OutputOnly A bool indicate if the service account is disabled.
# The field is currently in alpha phase.
"etag": "A String", # Optional. Note: `etag` is an inoperable legacy field that is only returned
# for backwards compatibility.
"uniqueId": "A String", # @OutputOnly The unique and stable id of the service account.
"email": "A String", # @OutputOnly The email address of the service account.
"name": "A String", # The resource name of the service account in the following format:
# `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
#
# Requests using `-` as a wildcard for the `PROJECT_ID` will infer the
# project from the `account` and the `ACCOUNT` value can be the `email`
# address or the `unique_id` of the service account.
#
# In responses the resource name will always be in the format
# `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A service account in the Identity and Access Management API.
#
# To create a service account, specify the `project_id` and the `account_id`
# for the account. The `account_id` is unique within the project, and is used
# to generate the service account email address and a stable
# `unique_id`.
#
# If the account already exists, the account's resource name is returned
# in the format of projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. The caller
# can use the name in other methods to access the account.
#
# All other methods can identify the service account using the 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.
"oauth2ClientId": "A String", # @OutputOnly The OAuth2 client id for the service account.
# This is used in conjunction with the OAuth2 clientconfig API to make
# three legged OAuth2 (3LO) flows to access the data of Google users.
"displayName": "A String", # Optional. A user-specified name for the service account.
# Must be less than or equal to 100 UTF-8 bytes.
"description": "A String", # Optional. A user-specified opaque description of the service account.
# Must be less than or equal to 256 UTF-8 bytes.
"projectId": "A String", # @OutputOnly The id of the project that owns the service account.
"disabled": True or False, # @OutputOnly A bool indicate if the service account is disabled.
# The field is currently in alpha phase.
"etag": "A String", # Optional. Note: `etag` is an inoperable legacy field that is only returned
# for backwards compatibility.
"uniqueId": "A String", # @OutputOnly The unique and stable id of the service account.
"email": "A String", # @OutputOnly The email address of the service account.
"name": "A String", # The resource name of the service account in the following format:
# `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
#
# Requests using `-` as a wildcard for the `PROJECT_ID` will infer the
# project from the `account` and the `ACCOUNT` value can be the `email`
# address or the `unique_id` of the service account.
#
# In responses the resource name will always be in the format
# `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
}</pre>
</div>
</body></html>