| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="iam_v1.html">Identity and Access Management (IAM) API</a> . <a href="iam_v1.projects.html">projects</a> . <a href="iam_v1.projects.serviceAccounts.html">serviceAccounts</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="iam_v1.projects.serviceAccounts.keys.html">keys()</a></code> |
| </p> |
| <p class="firstline">Returns the keys Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#create">create(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a ServiceAccount</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a ServiceAccount.</p> |
| <p class="toc_element"> |
| <code><a href="#disable">disable(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">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, options_requestedPolicyVersion=None, 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, pageSize=None, x__xgafv=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=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Patches a ServiceAccount.</p> |
| <p class="toc_element"> |
| <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Sets the Cloud IAM access control policy for a</p> |
| <p class="toc_element"> |
| <code><a href="#signBlob">signBlob(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">**Note**: This method is in the process of being deprecated. Call the</p> |
| <p class="toc_element"> |
| <code><a href="#signJwt">signJwt(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">**Note**: This method is in the process of being deprecated. Call the</p> |
| <p class="toc_element"> |
| <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, 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=None, 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=None, 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. |
| The object takes the form of: |
| |
| { # The service account create request. |
| "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. |
| "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` and `description`. |
| # |
| # 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. |
| "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}`. |
| "projectId": "A String", # @OutputOnly The id of the project that owns 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. |
| "uniqueId": "A String", # @OutputOnly The unique and stable id of the service account. |
| "description": "A String", # Optional. A user-specified opaque description of the service account. |
| # Must be less than or equal to 256 UTF-8 bytes. |
| "displayName": "A String", # Optional. A user-specified name for the service account. |
| # Must be less than or equal to 100 UTF-8 bytes. |
| "etag": "A String", # Optional. Note: `etag` is an inoperable legacy field that is only returned |
| # for backwards compatibility. |
| "disabled": True or False, # @OutputOnly A bool indicate if the service account is disabled. |
| # The field is currently in alpha phase. |
| }, |
| } |
| |
| 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. |
| "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}`. |
| "projectId": "A String", # @OutputOnly The id of the project that owns 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. |
| "uniqueId": "A String", # @OutputOnly The unique and stable id of the service account. |
| "description": "A String", # Optional. A user-specified opaque description of the service account. |
| # Must be less than or equal to 256 UTF-8 bytes. |
| "displayName": "A String", # Optional. A user-specified name for the service account. |
| # Must be less than or equal to 100 UTF-8 bytes. |
| "etag": "A String", # Optional. Note: `etag` is an inoperable legacy field that is only returned |
| # for backwards compatibility. |
| "disabled": True or False, # @OutputOnly A bool indicate if the service account is disabled. |
| # The field is currently in alpha phase. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Deletes a ServiceAccount. |
| |
| Args: |
| name: string, Required. The resource name of the service account in the following format: |
| `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. |
| Using `-` as a wildcard for the `PROJECT_ID` will infer the project from |
| the account. The `ACCOUNT` value can be the `email` address or the |
| `unique_id` of the service account. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # 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}`. |
| Using `-` as a wildcard for the `PROJECT_ID` will infer the project from |
| the account. The `ACCOUNT` value can be the `email` address or the |
| `unique_id` of the service account. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # The service account enable request. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated |
| # empty messages in your APIs. A typical example is to use it as the request |
| # or the response type of an API method. For instance: |
| # |
| # service Foo { |
| # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| # } |
| # |
| # The JSON representation for `Empty` is empty JSON object `{}`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets a ServiceAccount. |
| |
| Args: |
| name: string, Required. The resource name of the service account in the following format: |
| `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. |
| Using `-` as a wildcard for the `PROJECT_ID` will infer the project from |
| the account. The `ACCOUNT` value can be the `email` address or the |
| `unique_id` of the service account. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # 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. |
| "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}`. |
| "projectId": "A String", # @OutputOnly The id of the project that owns 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. |
| "uniqueId": "A String", # @OutputOnly The unique and stable id of the service account. |
| "description": "A String", # Optional. A user-specified opaque description of the service account. |
| # Must be less than or equal to 256 UTF-8 bytes. |
| "displayName": "A String", # Optional. A user-specified name for the service account. |
| # Must be less than or equal to 100 UTF-8 bytes. |
| "etag": "A String", # Optional. Note: `etag` is an inoperable legacy field that is only returned |
| # for backwards compatibility. |
| "disabled": True or False, # @OutputOnly A bool indicate if the service account is disabled. |
| # The field is currently in alpha phase. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, 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) |
| options_requestedPolicyVersion: integer, Optional. The policy format version to be returned. |
| |
| Valid values are 0, 1, and 3. Requests specifying an invalid value will be |
| rejected. |
| |
| Requests for policies with any conditional bindings must specify version 3. |
| Policies without any conditional bindings may specify any valid value or |
| leave the field unset. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # An Identity and Access Management (IAM) policy, which specifies access |
| # controls for Google Cloud resources. |
| # |
| # |
| # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| # `members` to a single `role`. Members can be user accounts, service accounts, |
| # Google groups, and domains (such as G Suite). A `role` is a named list of |
| # permissions; each `role` can be an IAM predefined role or a user-created |
| # custom role. |
| # |
| # Optionally, a `binding` can specify a `condition`, which is a logical |
| # expression that allows access to a resource only if the expression evaluates |
| # to `true`. A condition can add constraints based on attributes of the |
| # request, the resource, or both. |
| # |
| # **JSON example:** |
| # |
| # { |
| # "bindings": [ |
| # { |
| # "role": "roles/resourcemanager.organizationAdmin", |
| # "members": [ |
| # "user:mike@example.com", |
| # "group:admins@example.com", |
| # "domain:google.com", |
| # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| # ] |
| # }, |
| # { |
| # "role": "roles/resourcemanager.organizationViewer", |
| # "members": ["user:eve@example.com"], |
| # "condition": { |
| # "title": "expirable access", |
| # "description": "Does not grant access after Sep 2020", |
| # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| # } |
| # } |
| # ], |
| # "etag": "BwWWja0YfJA=", |
| # "version": 3 |
| # } |
| # |
| # **YAML example:** |
| # |
| # bindings: |
| # - members: |
| # - user:mike@example.com |
| # - group:admins@example.com |
| # - domain:google.com |
| # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| # role: roles/resourcemanager.organizationAdmin |
| # - members: |
| # - user:eve@example.com |
| # role: roles/resourcemanager.organizationViewer |
| # condition: |
| # title: expirable access |
| # description: Does not grant access after Sep 2020 |
| # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| # - etag: BwWWja0YfJA= |
| # - version: 3 |
| # |
| # For a description of IAM and its features, see the |
| # [IAM documentation](https://cloud.google.com/iam/docs/). |
| "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. |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| "version": 42, # Specifies the format of the policy. |
| # |
| # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| # are rejected. |
| # |
| # Any operation that affects conditional role bindings must specify version |
| # `3`. This requirement applies to the following operations: |
| # |
| # * Getting a policy that includes a conditional role binding |
| # * Adding a conditional role binding to a policy |
| # * Changing a conditional role binding in a policy |
| # * Removing any role binding, with or without a condition, from a policy |
| # that includes conditions |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| # |
| # If a policy does not include any conditions, operations on that policy may |
| # specify any valid version or leave the field unset. |
| "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:jose@example.com" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE", |
| # }, |
| # { |
| # "log_type": "ADMIN_READ", |
| # } |
| # ] |
| # }, |
| # { |
| # "service": "sampleservice.googleapis.com" |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # }, |
| # { |
| # "log_type": "DATA_WRITE", |
| # "exempted_members": [ |
| # "user:aliya@example.com" |
| # ] |
| # } |
| # ] |
| # } |
| # ] |
| # } |
| # |
| # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| # logging. It also exempts jose@example.com from DATA_READ logging, and |
| # aliya@example.com from DATA_WRITE logging. |
| "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. |
| "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:jose@example.com" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE", |
| # } |
| # ] |
| # } |
| # |
| # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| # jose@example.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. |
| }, |
| ], |
| }, |
| ], |
| "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| # `condition` that determines how and when the `bindings` are applied. Each |
| # of the `bindings` must contain at least one member. |
| { # Associates `members` with a `role`. |
| "condition": { # Represents a textual expression in the Common Expression Language (CEL) # 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. |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| # are documented at https://github.com/google/cel-spec. |
| # |
| # Example (Comparison): |
| # |
| # title: "Summary size limit" |
| # description: "Determines if a summary is less than 100 chars" |
| # expression: "document.summary.size() < 100" |
| # |
| # Example (Equality): |
| # |
| # title: "Requestor is owner" |
| # description: "Determines if requestor is the document owner" |
| # expression: "document.owner == request.auth.claims.email" |
| # |
| # Example (Logic): |
| # |
| # title: "Public documents" |
| # description: "Determine whether the document should be publicly visible" |
| # expression: "document.type != 'private' && document.type != 'internal'" |
| # |
| # Example (Data Manipulation): |
| # |
| # title: "Notification string" |
| # description: "Create a notification string with a timestamp." |
| # expression: "'New message received at ' + string(document.create_time)" |
| # |
| # The exact variables and functions that may be referenced within an expression |
| # are determined by the service that evaluates it. See the service |
| # documentation for additional information. |
| "description": "A String", # Optional. Description of the expression. This is a longer text which |
| # describes the expression, e.g. when hovered over it in a UI. |
| "expression": "A String", # Textual representation of an expression in Common Expression Language |
| # syntax. |
| "title": "A String", # 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. |
| "location": "A String", # Optional. String indicating the location of the expression for error |
| # reporting, e.g. a file name and a position in the file. |
| }, |
| "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, `alice@example.com` . |
| # |
| # |
| # * `serviceAccount:{emailid}`: An email address that represents a service |
| # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| # |
| # * `group:{emailid}`: An email address that represents a Google group. |
| # For example, `admins@example.com`. |
| # |
| # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a user that has been recently deleted. For |
| # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| # recovered, this value reverts to `user:{emailid}` and the recovered user |
| # retains the role in the binding. |
| # |
| # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| # unique identifier) representing a service account that has been recently |
| # deleted. For example, |
| # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| # If the service account is undeleted, this value reverts to |
| # `serviceAccount:{emailid}` and the undeleted service account retains the |
| # role in the binding. |
| # |
| # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a Google group that has been recently |
| # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| # the group is recovered, this value reverts to `group:{emailid}` and the |
| # recovered group retains the role in the binding. |
| # |
| # |
| # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| # users of that domain. For example, `google.com` or `example.com`. |
| # |
| "A String", |
| ], |
| "role": "A String", # Role that is assigned to `members`. |
| # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(name, pageToken=None, pageSize=None, x__xgafv=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. |
| 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. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The service account list response. |
| "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. |
| "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}`. |
| "projectId": "A String", # @OutputOnly The id of the project that owns 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. |
| "uniqueId": "A String", # @OutputOnly The unique and stable id of the service account. |
| "description": "A String", # Optional. A user-specified opaque description of the service account. |
| # Must be less than or equal to 256 UTF-8 bytes. |
| "displayName": "A String", # Optional. A user-specified name for the service account. |
| # Must be less than or equal to 100 UTF-8 bytes. |
| "etag": "A String", # Optional. Note: `etag` is an inoperable legacy field that is only returned |
| # for backwards compatibility. |
| "disabled": True or False, # @OutputOnly A bool indicate if the service account is disabled. |
| # The field is currently in alpha phase. |
| }, |
| ], |
| }</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=None, 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. |
| 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. |
| "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}`. |
| "projectId": "A String", # @OutputOnly The id of the project that owns 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. |
| "uniqueId": "A String", # @OutputOnly The unique and stable id of the service account. |
| "description": "A String", # Optional. A user-specified opaque description of the service account. |
| # Must be less than or equal to 256 UTF-8 bytes. |
| "displayName": "A String", # Optional. A user-specified name for the service account. |
| # Must be less than or equal to 100 UTF-8 bytes. |
| "etag": "A String", # Optional. Note: `etag` is an inoperable legacy field that is only returned |
| # for backwards compatibility. |
| "disabled": True or False, # @OutputOnly A bool indicate if the service account is disabled. |
| # The field is currently in alpha phase. |
| }, |
| "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. |
| "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}`. |
| "projectId": "A String", # @OutputOnly The id of the project that owns 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. |
| "uniqueId": "A String", # @OutputOnly The unique and stable id of the service account. |
| "description": "A String", # Optional. A user-specified opaque description of the service account. |
| # Must be less than or equal to 256 UTF-8 bytes. |
| "displayName": "A String", # Optional. A user-specified name for the service account. |
| # Must be less than or equal to 100 UTF-8 bytes. |
| "etag": "A String", # Optional. Note: `etag` is an inoperable legacy field that is only returned |
| # for backwards compatibility. |
| "disabled": True or False, # @OutputOnly A bool indicate if the service account is disabled. |
| # The field is currently in alpha phase. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, 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. |
| The object takes the form of: |
| |
| { # Request message for `SetIamPolicy` method. |
| "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of |
| # the policy is limited to a few 10s of KB. An empty policy is a |
| # valid policy but certain Cloud Platform services (such as Projects) |
| # might reject them. |
| # controls for Google Cloud resources. |
| # |
| # |
| # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| # `members` to a single `role`. Members can be user accounts, service accounts, |
| # Google groups, and domains (such as G Suite). A `role` is a named list of |
| # permissions; each `role` can be an IAM predefined role or a user-created |
| # custom role. |
| # |
| # Optionally, a `binding` can specify a `condition`, which is a logical |
| # expression that allows access to a resource only if the expression evaluates |
| # to `true`. A condition can add constraints based on attributes of the |
| # request, the resource, or both. |
| # |
| # **JSON example:** |
| # |
| # { |
| # "bindings": [ |
| # { |
| # "role": "roles/resourcemanager.organizationAdmin", |
| # "members": [ |
| # "user:mike@example.com", |
| # "group:admins@example.com", |
| # "domain:google.com", |
| # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| # ] |
| # }, |
| # { |
| # "role": "roles/resourcemanager.organizationViewer", |
| # "members": ["user:eve@example.com"], |
| # "condition": { |
| # "title": "expirable access", |
| # "description": "Does not grant access after Sep 2020", |
| # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| # } |
| # } |
| # ], |
| # "etag": "BwWWja0YfJA=", |
| # "version": 3 |
| # } |
| # |
| # **YAML example:** |
| # |
| # bindings: |
| # - members: |
| # - user:mike@example.com |
| # - group:admins@example.com |
| # - domain:google.com |
| # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| # role: roles/resourcemanager.organizationAdmin |
| # - members: |
| # - user:eve@example.com |
| # role: roles/resourcemanager.organizationViewer |
| # condition: |
| # title: expirable access |
| # description: Does not grant access after Sep 2020 |
| # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| # - etag: BwWWja0YfJA= |
| # - version: 3 |
| # |
| # For a description of IAM and its features, see the |
| # [IAM documentation](https://cloud.google.com/iam/docs/). |
| "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. |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| "version": 42, # Specifies the format of the policy. |
| # |
| # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| # are rejected. |
| # |
| # Any operation that affects conditional role bindings must specify version |
| # `3`. This requirement applies to the following operations: |
| # |
| # * Getting a policy that includes a conditional role binding |
| # * Adding a conditional role binding to a policy |
| # * Changing a conditional role binding in a policy |
| # * Removing any role binding, with or without a condition, from a policy |
| # that includes conditions |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| # |
| # If a policy does not include any conditions, operations on that policy may |
| # specify any valid version or leave the field unset. |
| "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:jose@example.com" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE", |
| # }, |
| # { |
| # "log_type": "ADMIN_READ", |
| # } |
| # ] |
| # }, |
| # { |
| # "service": "sampleservice.googleapis.com" |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # }, |
| # { |
| # "log_type": "DATA_WRITE", |
| # "exempted_members": [ |
| # "user:aliya@example.com" |
| # ] |
| # } |
| # ] |
| # } |
| # ] |
| # } |
| # |
| # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| # logging. It also exempts jose@example.com from DATA_READ logging, and |
| # aliya@example.com from DATA_WRITE logging. |
| "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. |
| "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:jose@example.com" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE", |
| # } |
| # ] |
| # } |
| # |
| # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| # jose@example.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. |
| }, |
| ], |
| }, |
| ], |
| "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| # `condition` that determines how and when the `bindings` are applied. Each |
| # of the `bindings` must contain at least one member. |
| { # Associates `members` with a `role`. |
| "condition": { # Represents a textual expression in the Common Expression Language (CEL) # 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. |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| # are documented at https://github.com/google/cel-spec. |
| # |
| # Example (Comparison): |
| # |
| # title: "Summary size limit" |
| # description: "Determines if a summary is less than 100 chars" |
| # expression: "document.summary.size() < 100" |
| # |
| # Example (Equality): |
| # |
| # title: "Requestor is owner" |
| # description: "Determines if requestor is the document owner" |
| # expression: "document.owner == request.auth.claims.email" |
| # |
| # Example (Logic): |
| # |
| # title: "Public documents" |
| # description: "Determine whether the document should be publicly visible" |
| # expression: "document.type != 'private' && document.type != 'internal'" |
| # |
| # Example (Data Manipulation): |
| # |
| # title: "Notification string" |
| # description: "Create a notification string with a timestamp." |
| # expression: "'New message received at ' + string(document.create_time)" |
| # |
| # The exact variables and functions that may be referenced within an expression |
| # are determined by the service that evaluates it. See the service |
| # documentation for additional information. |
| "description": "A String", # Optional. Description of the expression. This is a longer text which |
| # describes the expression, e.g. when hovered over it in a UI. |
| "expression": "A String", # Textual representation of an expression in Common Expression Language |
| # syntax. |
| "title": "A String", # 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. |
| "location": "A String", # Optional. String indicating the location of the expression for error |
| # reporting, e.g. a file name and a position in the file. |
| }, |
| "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, `alice@example.com` . |
| # |
| # |
| # * `serviceAccount:{emailid}`: An email address that represents a service |
| # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| # |
| # * `group:{emailid}`: An email address that represents a Google group. |
| # For example, `admins@example.com`. |
| # |
| # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a user that has been recently deleted. For |
| # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| # recovered, this value reverts to `user:{emailid}` and the recovered user |
| # retains the role in the binding. |
| # |
| # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| # unique identifier) representing a service account that has been recently |
| # deleted. For example, |
| # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| # If the service account is undeleted, this value reverts to |
| # `serviceAccount:{emailid}` and the undeleted service account retains the |
| # role in the binding. |
| # |
| # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a Google group that has been recently |
| # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| # the group is recovered, this value reverts to `group:{emailid}` and the |
| # recovered group retains the role in the binding. |
| # |
| # |
| # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| # users of that domain. For example, `google.com` or `example.com`. |
| # |
| "A String", |
| ], |
| "role": "A String", # Role that is assigned to `members`. |
| # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| }, |
| ], |
| }, |
| "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: |
| |
| { # An Identity and Access Management (IAM) policy, which specifies access |
| # controls for Google Cloud resources. |
| # |
| # |
| # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| # `members` to a single `role`. Members can be user accounts, service accounts, |
| # Google groups, and domains (such as G Suite). A `role` is a named list of |
| # permissions; each `role` can be an IAM predefined role or a user-created |
| # custom role. |
| # |
| # Optionally, a `binding` can specify a `condition`, which is a logical |
| # expression that allows access to a resource only if the expression evaluates |
| # to `true`. A condition can add constraints based on attributes of the |
| # request, the resource, or both. |
| # |
| # **JSON example:** |
| # |
| # { |
| # "bindings": [ |
| # { |
| # "role": "roles/resourcemanager.organizationAdmin", |
| # "members": [ |
| # "user:mike@example.com", |
| # "group:admins@example.com", |
| # "domain:google.com", |
| # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| # ] |
| # }, |
| # { |
| # "role": "roles/resourcemanager.organizationViewer", |
| # "members": ["user:eve@example.com"], |
| # "condition": { |
| # "title": "expirable access", |
| # "description": "Does not grant access after Sep 2020", |
| # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| # } |
| # } |
| # ], |
| # "etag": "BwWWja0YfJA=", |
| # "version": 3 |
| # } |
| # |
| # **YAML example:** |
| # |
| # bindings: |
| # - members: |
| # - user:mike@example.com |
| # - group:admins@example.com |
| # - domain:google.com |
| # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| # role: roles/resourcemanager.organizationAdmin |
| # - members: |
| # - user:eve@example.com |
| # role: roles/resourcemanager.organizationViewer |
| # condition: |
| # title: expirable access |
| # description: Does not grant access after Sep 2020 |
| # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| # - etag: BwWWja0YfJA= |
| # - version: 3 |
| # |
| # For a description of IAM and its features, see the |
| # [IAM documentation](https://cloud.google.com/iam/docs/). |
| "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. |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| "version": 42, # Specifies the format of the policy. |
| # |
| # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| # are rejected. |
| # |
| # Any operation that affects conditional role bindings must specify version |
| # `3`. This requirement applies to the following operations: |
| # |
| # * Getting a policy that includes a conditional role binding |
| # * Adding a conditional role binding to a policy |
| # * Changing a conditional role binding in a policy |
| # * Removing any role binding, with or without a condition, from a policy |
| # that includes conditions |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| # |
| # If a policy does not include any conditions, operations on that policy may |
| # specify any valid version or leave the field unset. |
| "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:jose@example.com" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE", |
| # }, |
| # { |
| # "log_type": "ADMIN_READ", |
| # } |
| # ] |
| # }, |
| # { |
| # "service": "sampleservice.googleapis.com" |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # }, |
| # { |
| # "log_type": "DATA_WRITE", |
| # "exempted_members": [ |
| # "user:aliya@example.com" |
| # ] |
| # } |
| # ] |
| # } |
| # ] |
| # } |
| # |
| # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| # logging. It also exempts jose@example.com from DATA_READ logging, and |
| # aliya@example.com from DATA_WRITE logging. |
| "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. |
| "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:jose@example.com" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE", |
| # } |
| # ] |
| # } |
| # |
| # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| # jose@example.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. |
| }, |
| ], |
| }, |
| ], |
| "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| # `condition` that determines how and when the `bindings` are applied. Each |
| # of the `bindings` must contain at least one member. |
| { # Associates `members` with a `role`. |
| "condition": { # Represents a textual expression in the Common Expression Language (CEL) # 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. |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| # are documented at https://github.com/google/cel-spec. |
| # |
| # Example (Comparison): |
| # |
| # title: "Summary size limit" |
| # description: "Determines if a summary is less than 100 chars" |
| # expression: "document.summary.size() < 100" |
| # |
| # Example (Equality): |
| # |
| # title: "Requestor is owner" |
| # description: "Determines if requestor is the document owner" |
| # expression: "document.owner == request.auth.claims.email" |
| # |
| # Example (Logic): |
| # |
| # title: "Public documents" |
| # description: "Determine whether the document should be publicly visible" |
| # expression: "document.type != 'private' && document.type != 'internal'" |
| # |
| # Example (Data Manipulation): |
| # |
| # title: "Notification string" |
| # description: "Create a notification string with a timestamp." |
| # expression: "'New message received at ' + string(document.create_time)" |
| # |
| # The exact variables and functions that may be referenced within an expression |
| # are determined by the service that evaluates it. See the service |
| # documentation for additional information. |
| "description": "A String", # Optional. Description of the expression. This is a longer text which |
| # describes the expression, e.g. when hovered over it in a UI. |
| "expression": "A String", # Textual representation of an expression in Common Expression Language |
| # syntax. |
| "title": "A String", # 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. |
| "location": "A String", # Optional. String indicating the location of the expression for error |
| # reporting, e.g. a file name and a position in the file. |
| }, |
| "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, `alice@example.com` . |
| # |
| # |
| # * `serviceAccount:{emailid}`: An email address that represents a service |
| # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| # |
| # * `group:{emailid}`: An email address that represents a Google group. |
| # For example, `admins@example.com`. |
| # |
| # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a user that has been recently deleted. For |
| # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| # recovered, this value reverts to `user:{emailid}` and the recovered user |
| # retains the role in the binding. |
| # |
| # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| # unique identifier) representing a service account that has been recently |
| # deleted. For example, |
| # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| # If the service account is undeleted, this value reverts to |
| # `serviceAccount:{emailid}` and the undeleted service account retains the |
| # role in the binding. |
| # |
| # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a Google group that has been recently |
| # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| # the group is recovered, this value reverts to `group:{emailid}` and the |
| # recovered group retains the role in the binding. |
| # |
| # |
| # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| # users of that domain. For example, `google.com` or `example.com`. |
| # |
| "A String", |
| ], |
| "role": "A String", # Role that is assigned to `members`. |
| # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="signBlob">signBlob(name, body=None, 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, Required. The resource name of the service account in the following format: |
| `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. |
| Using `-` as a wildcard for the `PROJECT_ID` will infer the project from |
| the account. The `ACCOUNT` value can be the `email` address or the |
| `unique_id` of the service account. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # The service account sign blob request. |
| "bytesToSign": "A String", # Required. 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. |
| "signature": "A String", # The signed blob. |
| "keyId": "A String", # The id of the key used to sign the blob. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="signJwt">signJwt(name, body=None, x__xgafv=None)</code> |
| <pre>**Note**: This method is 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, Required. The resource name of the service account in the following format: |
| `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. |
| Using `-` as a wildcard for the `PROJECT_ID` will infer the project from |
| the account. The `ACCOUNT` value can be the `email` address or the |
| `unique_id` of the service account. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # The service account sign JWT request. |
| "payload": "A String", # Required. 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=None, 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. |
| 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. |
| "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}`. |
| "projectId": "A String", # @OutputOnly The id of the project that owns 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. |
| "uniqueId": "A String", # @OutputOnly The unique and stable id of the service account. |
| "description": "A String", # Optional. A user-specified opaque description of the service account. |
| # Must be less than or equal to 256 UTF-8 bytes. |
| "displayName": "A String", # Optional. A user-specified name for the service account. |
| # Must be less than or equal to 100 UTF-8 bytes. |
| "etag": "A String", # Optional. Note: `etag` is an inoperable legacy field that is only returned |
| # for backwards compatibility. |
| "disabled": True or False, # @OutputOnly A bool indicate if the service account is disabled. |
| # The field is currently in alpha phase. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="update">update(name, body=None, 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. |
| 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. |
| "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}`. |
| "projectId": "A String", # @OutputOnly The id of the project that owns 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. |
| "uniqueId": "A String", # @OutputOnly The unique and stable id of the service account. |
| "description": "A String", # Optional. A user-specified opaque description of the service account. |
| # Must be less than or equal to 256 UTF-8 bytes. |
| "displayName": "A String", # Optional. A user-specified name for the service account. |
| # Must be less than or equal to 100 UTF-8 bytes. |
| "etag": "A String", # Optional. Note: `etag` is an inoperable legacy field that is only returned |
| # for backwards compatibility. |
| "disabled": True or False, # @OutputOnly A bool indicate if the service account is disabled. |
| # The field is currently in alpha phase. |
| } |
| |
| 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. |
| "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}`. |
| "projectId": "A String", # @OutputOnly The id of the project that owns 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. |
| "uniqueId": "A String", # @OutputOnly The unique and stable id of the service account. |
| "description": "A String", # Optional. A user-specified opaque description of the service account. |
| # Must be less than or equal to 256 UTF-8 bytes. |
| "displayName": "A String", # Optional. A user-specified name for the service account. |
| # Must be less than or equal to 100 UTF-8 bytes. |
| "etag": "A String", # Optional. Note: `etag` is an inoperable legacy field that is only returned |
| # for backwards compatibility. |
| "disabled": True or False, # @OutputOnly A bool indicate if the service account is disabled. |
| # The field is currently in alpha phase. |
| }</pre> |
| </div> |
| |
| </body></html> |