Regen all docs. (#700)
* Stop recursing if discovery == {}
* Generate docs with 'make docs'.
diff --git a/docs/dyn/iam_v1.projects.serviceAccounts.html b/docs/dyn/iam_v1.projects.serviceAccounts.html
index 34189b7..fda208d 100644
--- a/docs/dyn/iam_v1.projects.serviceAccounts.html
+++ b/docs/dyn/iam_v1.projects.serviceAccounts.html
@@ -72,7 +72,7 @@
</style>
-<h1><a href="iam_v1.html">Google 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>
+<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>
@@ -86,11 +86,17 @@
<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 IAM access control policy for a</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>
@@ -98,20 +104,26 @@
<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 IAM access control policy for a</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">Signs a blob using a service account's system-managed private key.</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">Signs a JWT using a service account's system-managed private key.</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">Updates a ServiceAccount.</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>
@@ -125,8 +137,8 @@
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:
+ "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`
@@ -135,33 +147,37 @@
# `unique_id`.
#
# If the account already exists, the account's resource name is returned
- # in util::Status's ResourceInfo.resource_name in the format of
- # projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}. The caller can
- # use the name in other methods to access the account.
+ # 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/{SERVICE_ACCOUNT_EMAIL}`.
- # Using `-` as a wildcard for the project will infer the project from
- # the account. The `account` value can be the `email` address or the
+ # `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.
+ "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 description of the service account. Must be
- # fewer than 100 UTF-8 bytes.
- "name": "A String", # The resource name of the service account in the following format:
- # `projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.
- #
- # Requests using `-` as a wildcard for the project 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/{SERVICE_ACCOUNT_EMAIL}`.
+ "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.
- "etag": "A String", # Used to perform a consistent read-modify-write.
+ "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,
@@ -185,33 +201,37 @@
# `unique_id`.
#
# If the account already exists, the account's resource name is returned
- # in util::Status's ResourceInfo.resource_name in the format of
- # projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}. The caller can
- # use the name in other methods to access the account.
+ # 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/{SERVICE_ACCOUNT_EMAIL}`.
- # Using `-` as a wildcard for the project will infer the project from
- # the account. The `account` value can be the `email` address or the
+ # `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.
+ "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 description of the service account. Must be
- # fewer than 100 UTF-8 bytes.
- "name": "A String", # The resource name of the service account in the following format:
- # `projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.
- #
- # Requests using `-` as a wildcard for the project 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/{SERVICE_ACCOUNT_EMAIL}`.
+ "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.
- "etag": "A String", # Used to perform a consistent read-modify-write.
+ "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>
@@ -221,9 +241,9 @@
Args:
name: string, The resource name of the service account in the following format:
-`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.
-Using `-` as a wildcard for the project will infer the project from
-the account. The `account` value can be the `email` address or the
+`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
@@ -246,14 +266,111 @@
</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/{SERVICE_ACCOUNT_EMAIL}`.
-Using `-` as a wildcard for the project will infer the project from
-the account. The `account` value can be the `email` address or the
+`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
@@ -271,41 +388,58 @@
# `unique_id`.
#
# If the account already exists, the account's resource name is returned
- # in util::Status's ResourceInfo.resource_name in the format of
- # projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}. The caller can
- # use the name in other methods to access the account.
+ # 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/{SERVICE_ACCOUNT_EMAIL}`.
- # Using `-` as a wildcard for the project will infer the project from
- # the account. The `account` value can be the `email` address or the
+ # `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.
+ "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 description of the service account. Must be
- # fewer than 100 UTF-8 bytes.
- "name": "A String", # The resource name of the service account in the following format:
- # `projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.
- #
- # Requests using `-` as a wildcard for the project 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/{SERVICE_ACCOUNT_EMAIL}`.
+ "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.
- "etag": "A String", # Used to perform a consistent read-modify-write.
+ "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 IAM access control policy for a
+ <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)
@@ -321,12 +455,12 @@
# specify access control policies for Cloud Platform resources.
#
#
- # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
+ # 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.
#
- # **Example**
+ # **JSON Example**
#
# {
# "bindings": [
@@ -336,7 +470,7 @@
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
- # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
+ # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
# ]
# },
# {
@@ -346,15 +480,27 @@
# ]
# }
#
+ # **YAML Example**
+ #
+ # bindings:
+ # - members:
+ # - user:mike@example.com
+ # - group:admins@example.com
+ # - domain:google.com
+ # - serviceAccount:my-other-app@appspot.gserviceaccount.com
+ # role: roles/owner
+ # - members:
+ # - user:sean@example.com
+ # role: roles/viewer
+ #
+ #
# For a description of IAM and its features, see the
- # [IAM developer's guide](https://cloud.google.com/iam).
+ # [IAM developer's guide](https://cloud.google.com/iam/docs).
"bindings": [ # Associates a list of `members` to a `role`.
- # Multiple `bindings` must not be specified for the same `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`.
- # Required
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
@@ -365,7 +511,7 @@
# 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@gmail.com` or `joe@example.com`.
+ # account. For example, `alice@gmail.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
@@ -375,11 +521,117 @@
# For example, `admins@example.com`.
#
#
- # * `domain:{domain}`: A Google Apps domain name that represents all the
+ # * `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:foo@gmail.com"
+ # ]
+ # },
+ # {
+ # "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:bar@gmail.com"
+ # ]
+ # }
+ # ]
+ # }
+ # ]
+ # }
+ #
+ # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+ # logging. It also exempts foo@gmail.com from DATA_READ logging, and
+ # bar@gmail.com 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:foo@gmail.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # }
+ # ]
+ # }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+ # foo@gmail.com 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
@@ -392,7 +644,7 @@
#
# If no `etag` is provided in the call to `setIamPolicy`, then the existing
# policy is overwritten blindly.
- "version": 42, # Version of the `Policy`. The default version is 0.
+ "version": 42, # Deprecated.
}</pre>
</div>
@@ -430,33 +682,37 @@
# `unique_id`.
#
# If the account already exists, the account's resource name is returned
- # in util::Status's ResourceInfo.resource_name in the format of
- # projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}. The caller can
- # use the name in other methods to access the account.
+ # 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/{SERVICE_ACCOUNT_EMAIL}`.
- # Using `-` as a wildcard for the project will infer the project from
- # the account. The `account` value can be the `email` address or the
+ # `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.
+ "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 description of the service account. Must be
- # fewer than 100 UTF-8 bytes.
- "name": "A String", # The resource name of the service account in the following format:
- # `projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.
- #
- # Requests using `-` as a wildcard for the project 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/{SERVICE_ACCOUNT_EMAIL}`.
+ "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.
- "etag": "A String", # Used to perform a consistent read-modify-write.
+ "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>
@@ -477,10 +733,143 @@
</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 IAM access control policy for a
+ <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)
@@ -495,12 +884,12 @@
# specify access control policies for Cloud Platform resources.
#
#
- # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
+ # 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.
#
- # **Example**
+ # **JSON Example**
#
# {
# "bindings": [
@@ -510,7 +899,7 @@
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
- # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
+ # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
# ]
# },
# {
@@ -520,15 +909,27 @@
# ]
# }
#
+ # **YAML Example**
+ #
+ # bindings:
+ # - members:
+ # - user:mike@example.com
+ # - group:admins@example.com
+ # - domain:google.com
+ # - serviceAccount:my-other-app@appspot.gserviceaccount.com
+ # role: roles/owner
+ # - members:
+ # - user:sean@example.com
+ # role: roles/viewer
+ #
+ #
# For a description of IAM and its features, see the
- # [IAM developer's guide](https://cloud.google.com/iam).
+ # [IAM developer's guide](https://cloud.google.com/iam/docs).
"bindings": [ # Associates a list of `members` to a `role`.
- # Multiple `bindings` must not be specified for the same `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`.
- # Required
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
@@ -539,7 +940,7 @@
# 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@gmail.com` or `joe@example.com`.
+ # account. For example, `alice@gmail.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
@@ -549,11 +950,117 @@
# For example, `admins@example.com`.
#
#
- # * `domain:{domain}`: A Google Apps domain name that represents all the
+ # * `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:foo@gmail.com"
+ # ]
+ # },
+ # {
+ # "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:bar@gmail.com"
+ # ]
+ # }
+ # ]
+ # }
+ # ]
+ # }
+ #
+ # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+ # logging. It also exempts foo@gmail.com from DATA_READ logging, and
+ # bar@gmail.com 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:foo@gmail.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # }
+ # ]
+ # }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+ # foo@gmail.com 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
@@ -566,8 +1073,13 @@
#
# If no `etag` is provided in the call to `setIamPolicy`, then the existing
# policy is overwritten blindly.
- "version": 42, # Version of the `Policy`. The default version is 0.
+ "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.
@@ -582,12 +1094,12 @@
# specify access control policies for Cloud Platform resources.
#
#
- # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
+ # 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.
#
- # **Example**
+ # **JSON Example**
#
# {
# "bindings": [
@@ -597,7 +1109,7 @@
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
- # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
+ # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
# ]
# },
# {
@@ -607,15 +1119,27 @@
# ]
# }
#
+ # **YAML Example**
+ #
+ # bindings:
+ # - members:
+ # - user:mike@example.com
+ # - group:admins@example.com
+ # - domain:google.com
+ # - serviceAccount:my-other-app@appspot.gserviceaccount.com
+ # role: roles/owner
+ # - members:
+ # - user:sean@example.com
+ # role: roles/viewer
+ #
+ #
# For a description of IAM and its features, see the
- # [IAM developer's guide](https://cloud.google.com/iam).
+ # [IAM developer's guide](https://cloud.google.com/iam/docs).
"bindings": [ # Associates a list of `members` to a `role`.
- # Multiple `bindings` must not be specified for the same `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`.
- # Required
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
@@ -626,7 +1150,7 @@
# 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@gmail.com` or `joe@example.com`.
+ # account. For example, `alice@gmail.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
@@ -636,11 +1160,117 @@
# For example, `admins@example.com`.
#
#
- # * `domain:{domain}`: A Google Apps domain name that represents all the
+ # * `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:foo@gmail.com"
+ # ]
+ # },
+ # {
+ # "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:bar@gmail.com"
+ # ]
+ # }
+ # ]
+ # }
+ # ]
+ # }
+ #
+ # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+ # logging. It also exempts foo@gmail.com from DATA_READ logging, and
+ # bar@gmail.com 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:foo@gmail.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # }
+ # ]
+ # }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+ # foo@gmail.com 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
@@ -653,19 +1283,23 @@
#
# If no `etag` is provided in the call to `setIamPolicy`, then the existing
# policy is overwritten blindly.
- "version": 42, # Version of the `Policy`. The default version is 0.
+ "version": 42, # Deprecated.
}</pre>
</div>
<div class="method">
<code class="details" id="signBlob">signBlob(name, body, x__xgafv=None)</code>
- <pre>Signs a blob using a service account's system-managed private key.
+ <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/{SERVICE_ACCOUNT_EMAIL}`.
-Using `-` as a wildcard for the project will infer the project from
-the account. The `account` value can be the `email` address or the
+`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:
@@ -690,7 +1324,11 @@
<div class="method">
<code class="details" id="signJwt">signJwt(name, body, x__xgafv=None)</code>
- <pre>Signs a JWT using a service account's system-managed private key.
+ <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
@@ -698,9 +1336,9 @@
Args:
name: string, The resource name of the service account in the following format:
-`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.
-Using `-` as a wildcard for the project will infer the project from
-the account. The `account` value can be the `email` address or the
+`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:
@@ -760,23 +1398,94 @@
</div>
<div class="method">
- <code class="details" id="update">update(name, body, x__xgafv=None)</code>
- <pre>Updates a ServiceAccount.
-
-Currently, only the following fields are updatable:
-`display_name` .
-The `etag` is mandatory.
+ <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/{SERVICE_ACCOUNT_EMAIL}`.
+`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:
-Requests using `-` as a wildcard for the project will infer the project
-from the `account` and the `account` value can be the `email` address or
-the `unique_id` of the service account.
+{ # 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/{SERVICE_ACCOUNT_EMAIL}`. (required)
+`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. (required)
body: object, The request body. (required)
The object takes the form of:
@@ -788,33 +1497,37 @@
# `unique_id`.
#
# If the account already exists, the account's resource name is returned
- # in util::Status's ResourceInfo.resource_name in the format of
- # projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}. The caller can
- # use the name in other methods to access the account.
+ # 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/{SERVICE_ACCOUNT_EMAIL}`.
- # Using `-` as a wildcard for the project will infer the project from
- # the account. The `account` value can be the `email` address or the
+ # `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.
+ "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 description of the service account. Must be
- # fewer than 100 UTF-8 bytes.
- "name": "A String", # The resource name of the service account in the following format:
- # `projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.
- #
- # Requests using `-` as a wildcard for the project 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/{SERVICE_ACCOUNT_EMAIL}`.
+ "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.
- "etag": "A String", # Used to perform a consistent read-modify-write.
+ "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.
@@ -833,33 +1546,37 @@
# `unique_id`.
#
# If the account already exists, the account's resource name is returned
- # in util::Status's ResourceInfo.resource_name in the format of
- # projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}. The caller can
- # use the name in other methods to access the account.
+ # 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/{SERVICE_ACCOUNT_EMAIL}`.
- # Using `-` as a wildcard for the project will infer the project from
- # the account. The `account` value can be the `email` address or the
+ # `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.
+ "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 description of the service account. Must be
- # fewer than 100 UTF-8 bytes.
- "name": "A String", # The resource name of the service account in the following format:
- # `projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.
- #
- # Requests using `-` as a wildcard for the project 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/{SERVICE_ACCOUNT_EMAIL}`.
+ "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.
- "etag": "A String", # Used to perform a consistent read-modify-write.
+ "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>