Google - API Identity and Access Management (IAM)

Google / Identity and Access Management (IAM)

Identity and Access Management (IAM)

Manages identity and access control for Google Cloud Platform resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls.

License: Creative Commons Attribution 3.0

Resources

iamPolicies

POST

/v1/iamPolicies:lintPolicy

Lints a Cloud IAM policy object or its sub fields. Currently supports google.iam.v1.Binding.condition.

Each lint operation consists of multiple lint validation units. Each unit inspects the input object in regard to a particular linting aspect and issues a google.iam.admin.v1.LintResult disclosing the result.

The set of applicable validation units is determined by the Cloud IAM server and is not configurable.

Regardless of any lint issues or their severities, successful calls to lintPolicy return an HTTP 200 OK status code.

Request

Body

Name Data Type Description

LintPolicyRequest


                        LintPolicyRequest

object

The request to lint a Cloud IAM policy object.

Properties


                        fullResourceName

string

The full resource name of the policy this lint request is about.

The name follows the Google Cloud Platform (GCP) resource format. For example, a GCP project with ID my-project will be named //cloudresourcemanager.googleapis.com/projects/my-project.

The resource name is not used to read the policy instance from the Cloud IAM database. The candidate policy for lint has to be provided in the same request object.


                        condition

Expr

google.iam.v1.Binding.condition object to be linted.


                        Expr

object

Represents an expression text. Example:

title: "User account presence"
description: "Determines whether the request has a user account"
expression: "size(request.user) > 0"

Properties

`title`	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.
`location`	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`	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`	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.

Responses

200Successful response

Body

Name Data Type Description

LintPolicyResponse


                        LintPolicyResponse

object

The response of a lint operation. An empty response indicates the operation was able to fully execute and no lint issue was found.

Properties


                        lintResults

array [LintResult]

List of lint results sorted by severity in descending order.


                        LintResult

object

Structured response of a single validation unit.

Properties

`validationUnitName`	string	The validation unit name, for instance "lintValidationUnits/ConditionComplexityCheck".
`severity`	string Allowed values: - `SEVERITY_UNSPECIFIED` - `ERROR` - `WARNING` - `NOTICE` - `INFO` - `DEPRECATED`	The validation unit severity.
`locationOffset`	integer	0-based character position of problematic construct within the object identified by `field_name`. Currently, this is populated only for condition expression.
`level`	string Allowed values: - `LEVEL_UNSPECIFIED` - `CONDITION`	The validation unit level.
`fieldName`	string	The name of the field for which this lint result is about. For nested messages `field_name` consists of names of the embedded fields separated by period character. The top-level qualifier is the input object to lint in the request. For example, the `field_name` value `condition.expression` identifies a lint result for the `expression` field of the provided condition.
`debugMessage`	string	Human readable debug message associated with the issue.

POST

/v1/iamPolicies:queryAuditableServices

Returns a list of services that support service level audit logging configuration for the given resource.

Request

Body

Name Data Type Description

QueryAuditableServicesRequest


                        QueryAuditableServicesRequest

object

A request to get the list of auditable services for a resource.

Properties


                        fullResourceName

string

Required. The full resource name to query from the list of auditable services.

The name follows the Google Cloud Platform resource format. For example, a Cloud Platform project with id my-project will be named //cloudresourcemanager.googleapis.com/projects/my-project.

Responses

200Successful response

Body

Name Data Type Description

QueryAuditableServicesResponse


                        QueryAuditableServicesResponse

object

A response containing a list of auditable services for a resource.

Properties


                        services

array [AuditableService]

The auditable services for a resource.


                        AuditableService

object

Contains information about an auditable service.

Properties


                        name

string

Public name of the service. For example, the service name for Cloud IAM is 'iam.googleapis.com'.

organizations

POST

/v1/{name}:undelete

Undelete a Role, bringing it back in its previous state.

Request

Path

Name	Data Type	Description
`name`	string	The `name` parameter's value depends on the target resource for the request, namely `projects` or `organizations`. Each resource type's `name` value format is described below: `projects.roles.undelete()`: `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only custom roles that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` `organizations.roles.undelete()`: `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes only custom roles that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.

Body

Name Data Type Description

UndeleteRoleRequest


                        UndeleteRoleRequest

object

The request to undelete an existing role.

Properties


                        etag

byte

Used to perform a consistent read-modify-write.

Responses

200Successful response

Body

Name Data Type Description

Role


                        Role

object

A role in the Identity and Access Management API.

Properties

`title`	string	Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
`stage`	string Allowed values: - `ALPHA` - `BETA` - `GA` - `DEPRECATED` - `DISABLED` - `EAP`	The current launch stage of the role. If the `ALPHA` launch stage has been selected for a role, the `stage` field will not be included in the returned definition for the role.
`name`	string	The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
`includedPermissions`	array [string]	The names of the permissions this role grants when bound in an IAM policy.
`etag`	byte	Used to perform a consistent read-modify-write.
`description`	string	Optional. A human-readable description for the role.
`deleted`	boolean	The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.

DELETE

/v1/{name}

Soft deletes a role. The role is suspended and cannot be used to create new IAM Policy Bindings. The Role will not be included in ListRoles() unless show_deleted is set in the ListRolesRequest. The Role contains the deleted boolean set. Existing Bindings remains, but are inactive. The Role can be undeleted within 7 days. After 7 days the Role is deleted and all Bindings associated with the role are removed.

Request

Path

Name	Data Type	Description
`name`	string	The `name` parameter's value depends on the target resource for the request, namely `projects` or `organizations`. Each resource type's `name` value format is described below: `projects.roles.delete()`: `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only custom roles that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` `organizations.roles.delete()`: `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only custom roles that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.

Query

Name	Data Type	Description
`etag`	string	Used to perform a consistent read-modify-write.

Responses

200Successful response

Body

Name Data Type Description

Role


                        Role

object

A role in the Identity and Access Management API.

Properties

`title`	string	Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
`stage`	string Allowed values: - `ALPHA` - `BETA` - `GA` - `DEPRECATED` - `DISABLED` - `EAP`	The current launch stage of the role. If the `ALPHA` launch stage has been selected for a role, the `stage` field will not be included in the returned definition for the role.
`name`	string	The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
`includedPermissions`	array [string]	The names of the permissions this role grants when bound in an IAM policy.
`etag`	byte	Used to perform a consistent read-modify-write.
`description`	string	Optional. A human-readable description for the role.
`deleted`	boolean	The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.

GET

/v1/{name}

Gets a Role definition.

Request

Path

Name	Data Type	Description
`name`	string	The `name` parameter's value depends on the target resource for the request, namely `roles`, `projects`, or `organizations`. Each resource type's `name` value format is described below: `roles.get()`: `roles/{ROLE_NAME}`. This method returns results from all predefined roles in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` `projects.roles.get()`: `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only custom roles that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` `organizations.roles.get()`: `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only custom roles that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.

Query

Name	Data Type	Description
`publicKeyType`	string Allowed values: - `TYPE_NONE` - `TYPE_X509_PEM_FILE` - `TYPE_RAW_PUBLIC_KEY`	The output format of the public key requested. X509_PEM is the default output format.

Responses

200Successful response

Body

Name Data Type Description

Role


                        Role

object

A role in the Identity and Access Management API.

Properties

`title`	string	Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
`stage`	string Allowed values: - `ALPHA` - `BETA` - `GA` - `DEPRECATED` - `DISABLED` - `EAP`	The current launch stage of the role. If the `ALPHA` launch stage has been selected for a role, the `stage` field will not be included in the returned definition for the role.
`name`	string	The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
`includedPermissions`	array [string]	The names of the permissions this role grants when bound in an IAM policy.
`etag`	byte	Used to perform a consistent read-modify-write.
`description`	string	Optional. A human-readable description for the role.
`deleted`	boolean	The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.

PATCH

/v1/{name}

Updates a Role definition.

Request

Path

Name	Data Type	Description
`name`	string	The `name` parameter's value depends on the target resource for the request, namely `projects` or `organizations`. Each resource type's `name` value format is described below: `projects.roles.patch()`: `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only custom roles that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` `organizations.roles.patch()`: `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only custom roles that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.

Query

Name	Data Type	Description
`updateMask`	string	A mask describing which fields in the Role have changed.

Body

Name Data Type Description

Role


                        Role

object

A role in the Identity and Access Management API.

Properties

`title`	string	Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
`stage`	string Allowed values: - `ALPHA` - `BETA` - `GA` - `DEPRECATED` - `DISABLED` - `EAP`	The current launch stage of the role. If the `ALPHA` launch stage has been selected for a role, the `stage` field will not be included in the returned definition for the role.
`name`	string	The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
`includedPermissions`	array [string]	The names of the permissions this role grants when bound in an IAM policy.
`etag`	byte	Used to perform a consistent read-modify-write.
`description`	string	Optional. A human-readable description for the role.
`deleted`	boolean	The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.

Responses

200Successful response

Body

Name Data Type Description

Role


                        Role

object

A role in the Identity and Access Management API.

Properties

`title`	string	Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
`stage`	string Allowed values: - `ALPHA` - `BETA` - `GA` - `DEPRECATED` - `DISABLED` - `EAP`	The current launch stage of the role. If the `ALPHA` launch stage has been selected for a role, the `stage` field will not be included in the returned definition for the role.
`name`	string	The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
`includedPermissions`	array [string]	The names of the permissions this role grants when bound in an IAM policy.
`etag`	byte	Used to perform a consistent read-modify-write.
`description`	string	Optional. A human-readable description for the role.
`deleted`	boolean	The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.

GET

/v1/{parent}/roles

Lists the Roles defined on a resource.

Request

Path

Name	Data Type	Description
`parent`	string	The `parent` parameter's value depends on the target resource for the request, namely `roles`, `projects`, or `organizations`. Each resource type's `parent` value format is described below: `roles.list()`: An empty string. This method doesn't require a resource; it simply returns all predefined roles in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles` `projects.roles.list()`: `projects/{PROJECT_ID}`. This method lists all project-level custom roles. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` `organizations.roles.list()`: `organizations/{ORGANIZATION_ID}`. This method lists all organization-level custom roles. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.

Query

Name	Data Type	Description
`view`	string Allowed values: - `BASIC` - `FULL`	Optional view for the returned Role objects. When `FULL` is specified, the `includedPermissions` field is returned, which includes a list of all permissions in the role. The default value is `BASIC`, which does not return the `includedPermissions` field.
`showDeleted`	boolean	Include Roles that have been deleted.
`pageToken`	string	Optional pagination token returned in an earlier ListRolesResponse.
`pageSize`	integer	Optional limit on the number of roles to include in the response.

Responses

200Successful response

Body

Name Data Type Description

ListRolesResponse


                        ListRolesResponse

object

The response containing the roles defined under a resource.

Properties


                        roles

array [Role]

The Roles defined on this resource.


                        Role

object

A role in the Identity and Access Management API.

Properties

`title`	string	Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
`stage`	string Allowed values: - `ALPHA` - `BETA` - `GA` - `DEPRECATED` - `DISABLED` - `EAP`	The current launch stage of the role. If the `ALPHA` launch stage has been selected for a role, the `stage` field will not be included in the returned definition for the role.
`name`	string	The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
`includedPermissions`	array [string]	The names of the permissions this role grants when bound in an IAM policy.
`etag`	byte	Used to perform a consistent read-modify-write.
`description`	string	Optional. A human-readable description for the role.
`deleted`	boolean	The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.


                        nextPageToken

string

To retrieve the next page of results, set ListRolesRequest.page_token to this value.

POST

/v1/{parent}/roles

Creates a new Role.

Request

Path

Name	Data Type	Description
`parent`	string	The `parent` parameter's value depends on the target resource for the request, namely `projects` or `organizations`. Each resource type's `parent` value format is described below: `projects.roles.create()`: `projects/{PROJECT_ID}`. This method creates project-level custom roles. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` `organizations.roles.create()`: `organizations/{ORGANIZATION_ID}`. This method creates organization-level custom roles. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.

Body

Name Data Type Description

CreateRoleRequest


                        CreateRoleRequest

object

The request to create a new role.

Properties


                        roleId

string

The role ID to use for this role.


                        role

Role

The Role resource to create.


                        Role

object

A role in the Identity and Access Management API.

Properties

`title`	string	Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
`stage`	string Allowed values: - `ALPHA` - `BETA` - `GA` - `DEPRECATED` - `DISABLED` - `EAP`	The current launch stage of the role. If the `ALPHA` launch stage has been selected for a role, the `stage` field will not be included in the returned definition for the role.
`name`	string	The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
`includedPermissions`	array [string]	The names of the permissions this role grants when bound in an IAM policy.
`etag`	byte	Used to perform a consistent read-modify-write.
`description`	string	Optional. A human-readable description for the role.
`deleted`	boolean	The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.

Responses

200Successful response

Body

Name Data Type Description

Role


                        Role

object

A role in the Identity and Access Management API.

Properties

`title`	string	Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
`stage`	string Allowed values: - `ALPHA` - `BETA` - `GA` - `DEPRECATED` - `DISABLED` - `EAP`	The current launch stage of the role. If the `ALPHA` launch stage has been selected for a role, the `stage` field will not be included in the returned definition for the role.
`name`	string	The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
`includedPermissions`	array [string]	The names of the permissions this role grants when bound in an IAM policy.
`etag`	byte	Used to perform a consistent read-modify-write.
`description`	string	Optional. A human-readable description for the role.
`deleted`	boolean	The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.

permissions

POST

/v1/permissions:queryTestablePermissions

Lists the permissions testable on a resource. A permission is testable if it can be tested for an identity on a resource.

Request

Body

Name Data Type Description

QueryTestablePermissionsRequest


                        QueryTestablePermissionsRequest

object

A request to get permissions which can be tested on a resource.

Properties

`pageToken`	string	Optional pagination token returned in an earlier QueryTestablePermissionsRequest.
`pageSize`	integer	Optional limit on the number of permissions to include in the response.
`fullResourceName`	string	Required. The full resource name to query from the list of testable permissions. The name follows the Google Cloud Platform resource format. For example, a Cloud Platform project with id `my-project` will be named `//cloudresourcemanager.googleapis.com/projects/my-project`.

Responses

200Successful response

Body

Name Data Type Description

QueryTestablePermissionsResponse


                        QueryTestablePermissionsResponse

object

The response containing permissions which can be tested on a resource.

Properties


                        permissions

array [Permission]

The Permissions testable on the requested resource.


                        Permission

object

A permission which can be included by a role.

Properties

`title`	string	The title of this Permission.
`stage`	string Allowed values: - `ALPHA` - `BETA` - `GA` - `DEPRECATED`	The current launch stage of the permission.
`primaryPermission`	string	The preferred name for this permission. If present, then this permission is an alias of, and equivalent to, the listed primary_permission.
`onlyInPredefinedRoles`	boolean
`name`	string	The name of this Permission.
`description`	string	A brief description of what this Permission is used for. This permission can ONLY be used in predefined roles.
`customRolesSupportLevel`	string Allowed values: - `SUPPORTED` - `TESTING` - `NOT_SUPPORTED`	The current custom role support level.
`apiDisabled`	boolean	The service API associated with the permission is not enabled.


                        nextPageToken

string

To retrieve the next page of results, set QueryTestableRolesRequest.page_token to this value.

projects

POST

/v1/{name}/keys:upload

Upload public key for a given service account. This rpc will create a ServiceAccountKey that has the provided public key and returns it.

Request

Path

Name	Data Type	Description
`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.

Body

Name Data Type Description

UploadServiceAccountKeyRequest


                        UploadServiceAccountKeyRequest

object

The service account key upload request.

Properties


                        publicKeyData

byte

A field that allows clients to upload their own public key. If set, use this public key data to create a service account key for given service account. Please note, the expected format for this field is X509_PEM.

Responses

200Successful response

Body

Name Data Type Description

ServiceAccountKey


                        ServiceAccountKey

object

Represents a service account key.

A service account has two sets of key-pairs: user-managed, and system-managed.

User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key.

System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. We recommend caching the public key set for a service account for no more than 24 hours to ensure you have access to the latest keys.

Public keys for all service accounts are also published at the OAuth2 Service Account API.

Properties

`validBeforeTime`	string	The key can be used before this timestamp. For system-managed key pairs, this timestamp is the end time for the private key signing operation. The public key could still be used for verification for a few hours after this time.
`validAfterTime`	string	The key can be used after this timestamp.
`publicKeyData`	byte	The public key data. Only provided in `GetServiceAccountKey` responses.
`privateKeyType`	string Allowed values: - `TYPE_UNSPECIFIED` - `TYPE_PKCS12_FILE` - `TYPE_GOOGLE_CREDENTIALS_FILE`	The output format for the private key. Only provided in `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or `ListServiceAccountKey` responses. Google never exposes system-managed private keys, and never retains user-managed private keys.
`privateKeyData`	byte	The private key data. Only provided in `CreateServiceAccountKey` responses. Make sure to keep the private key data secure because it allows for the assertion of the service account identity. When base64 decoded, the private key data can be used to authenticate with Google API client libraries and with gcloud auth activate-service-account.
`name`	string	The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.
`keyType`	string Allowed values: - `KEY_TYPE_UNSPECIFIED` - `USER_MANAGED` - `SYSTEM_MANAGED`	The key type.
`keyOrigin`	string Allowed values: - `ORIGIN_UNSPECIFIED` - `USER_PROVIDED` - `GOOGLE_PROVIDED`	The key origin.
`keyAlgorithm`	string Allowed values: - `KEY_ALG_UNSPECIFIED` - `KEY_ALG_RSA_1024` - `KEY_ALG_RSA_2048`	Specifies the algorithm (and possibly key size) for the key.

GET

/v1/{name}/keys

Lists ServiceAccountKeys.

Request

Path

Name	Data Type	Description
`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.

Query

Name	Data Type	Description
`keyTypes`	array	Filters the types of keys the user wants to include in the list response. Duplicate key types are not allowed. If no key type is provided, all keys are returned.

Responses

200Successful response

Body

Name Data Type Description

ListServiceAccountKeysResponse


                        ListServiceAccountKeysResponse

object

The service account keys list response.

Properties


                        keys

array [ServiceAccountKey]

The public keys for the service account.


                        ServiceAccountKey

object

Represents a service account key.

A service account has two sets of key-pairs: user-managed, and system-managed.

Public keys for all service accounts are also published at the OAuth2 Service Account API.

Properties

`validBeforeTime`	string	The key can be used before this timestamp. For system-managed key pairs, this timestamp is the end time for the private key signing operation. The public key could still be used for verification for a few hours after this time.
`validAfterTime`	string	The key can be used after this timestamp.
`publicKeyData`	byte	The public key data. Only provided in `GetServiceAccountKey` responses.
`privateKeyType`	string Allowed values: - `TYPE_UNSPECIFIED` - `TYPE_PKCS12_FILE` - `TYPE_GOOGLE_CREDENTIALS_FILE`	The output format for the private key. Only provided in `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or `ListServiceAccountKey` responses. Google never exposes system-managed private keys, and never retains user-managed private keys.
`privateKeyData`	byte	The private key data. Only provided in `CreateServiceAccountKey` responses. Make sure to keep the private key data secure because it allows for the assertion of the service account identity. When base64 decoded, the private key data can be used to authenticate with Google API client libraries and with gcloud auth activate-service-account.
`name`	string	The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.
`keyType`	string Allowed values: - `KEY_TYPE_UNSPECIFIED` - `USER_MANAGED` - `SYSTEM_MANAGED`	The key type.
`keyOrigin`	string Allowed values: - `ORIGIN_UNSPECIFIED` - `USER_PROVIDED` - `GOOGLE_PROVIDED`	The key origin.
`keyAlgorithm`	string Allowed values: - `KEY_ALG_UNSPECIFIED` - `KEY_ALG_RSA_1024` - `KEY_ALG_RSA_2048`	Specifies the algorithm (and possibly key size) for the key.

POST

/v1/{name}/keys

Creates a ServiceAccountKey and returns it.

Request

Path

Name	Data Type	Description
`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.

Body

Name Data Type Description

CreateServiceAccountKeyRequest


                        CreateServiceAccountKeyRequest

object

The service account key create request.

Properties

`privateKeyType`	string Allowed values: - `TYPE_UNSPECIFIED` - `TYPE_PKCS12_FILE` - `TYPE_GOOGLE_CREDENTIALS_FILE`	The output format of the private key. The default value is `TYPE_GOOGLE_CREDENTIALS_FILE`, which is the Google Credentials File format.
`keyAlgorithm`	string Allowed values: - `KEY_ALG_UNSPECIFIED` - `KEY_ALG_RSA_1024` - `KEY_ALG_RSA_2048`	Which type of key and algorithm to use for the key. The default is currently a 2K RSA key. However this may change in the future.

Responses

200Successful response

Body

Name Data Type Description

ServiceAccountKey


                        ServiceAccountKey

object

Represents a service account key.

A service account has two sets of key-pairs: user-managed, and system-managed.

Public keys for all service accounts are also published at the OAuth2 Service Account API.

Properties

`validBeforeTime`	string	The key can be used before this timestamp. For system-managed key pairs, this timestamp is the end time for the private key signing operation. The public key could still be used for verification for a few hours after this time.
`validAfterTime`	string	The key can be used after this timestamp.
`publicKeyData`	byte	The public key data. Only provided in `GetServiceAccountKey` responses.
`privateKeyType`	string Allowed values: - `TYPE_UNSPECIFIED` - `TYPE_PKCS12_FILE` - `TYPE_GOOGLE_CREDENTIALS_FILE`	The output format for the private key. Only provided in `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or `ListServiceAccountKey` responses. Google never exposes system-managed private keys, and never retains user-managed private keys.
`privateKeyData`	byte	The private key data. Only provided in `CreateServiceAccountKey` responses. Make sure to keep the private key data secure because it allows for the assertion of the service account identity. When base64 decoded, the private key data can be used to authenticate with Google API client libraries and with gcloud auth activate-service-account.
`name`	string	The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.
`keyType`	string Allowed values: - `KEY_TYPE_UNSPECIFIED` - `USER_MANAGED` - `SYSTEM_MANAGED`	The key type.
`keyOrigin`	string Allowed values: - `ORIGIN_UNSPECIFIED` - `USER_PROVIDED` - `GOOGLE_PROVIDED`	The key origin.
`keyAlgorithm`	string Allowed values: - `KEY_ALG_UNSPECIFIED` - `KEY_ALG_RSA_1024` - `KEY_ALG_RSA_2048`	Specifies the algorithm (and possibly key size) for the key.

GET

/v1/{name}/serviceAccounts

Lists ServiceAccounts for a project.

Request

Path

Name	Data Type	Description
`name`	string	Required. The resource name of the project associated with the service accounts, such as `projects/my-project-123`.

Query

Name	Data Type	Description
`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.

Responses

200Successful response

Body

Name Data Type Description

ListServiceAccountsResponse


                        ListServiceAccountsResponse

object

The service account list response.

Properties


                        nextPageToken

string

To retrieve the next page of results, set ListServiceAccountsRequest.page_token to this value.


                        accounts

array [ServiceAccount]

The list of matching service accounts.


                        ServiceAccount

object

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.

Properties

`uniqueId`	string	@OutputOnly The unique and stable id of the service account.
`projectId`	string	@OutputOnly The id of the project that owns the service account.
`oauth2ClientId`	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.
`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}`.
`etag`	byte	Optional. Note: `etag` is an inoperable legacy field that is only returned for backwards compatibility.
`email`	string	@OutputOnly The email address of the service account.
`displayName`	string	Optional. A user-specified name for the service account. Must be less than or equal to 100 UTF-8 bytes.
`disabled`	boolean	@OutputOnly A bool indicate if the service account is disabled. The field is currently in alpha phase.
`description`	string	Optional. A user-specified opaque description of the service account. Must be less than or equal to 256 UTF-8 bytes.

POST

/v1/{name}/serviceAccounts

Creates a ServiceAccount and returns it.

Request

Path

Name	Data Type	Description
`name`	string	Required. The resource name of the project associated with the service accounts, such as `projects/my-project-123`.

Body

Name Data Type Description

CreateServiceAccountRequest


                        CreateServiceAccountRequest

object

The service account create request.

Properties


                        serviceAccount

ServiceAccount

The ServiceAccount resource to create. Currently, only the following values are user assignable: display_name and description.


                        ServiceAccount

object

A service account in the Identity and Access Management API.

Properties

`uniqueId`	string	@OutputOnly The unique and stable id of the service account.
`projectId`	string	@OutputOnly The id of the project that owns the service account.
`oauth2ClientId`	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.
`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}`.
`etag`	byte	Optional. Note: `etag` is an inoperable legacy field that is only returned for backwards compatibility.
`email`	string	@OutputOnly The email address of the service account.
`displayName`	string	Optional. A user-specified name for the service account. Must be less than or equal to 100 UTF-8 bytes.
`disabled`	boolean	@OutputOnly A bool indicate if the service account is disabled. The field is currently in alpha phase.
`description`	string	Optional. A user-specified opaque description of the service account. Must be less than or equal to 256 UTF-8 bytes.


                        accountId

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.

Responses

200Successful response

Body

Name Data Type Description

ServiceAccount


                        ServiceAccount

object

A service account in the Identity and Access Management API.

Properties

`uniqueId`	string	@OutputOnly The unique and stable id of the service account.
`projectId`	string	@OutputOnly The id of the project that owns the service account.
`oauth2ClientId`	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.
`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}`.
`etag`	byte	Optional. Note: `etag` is an inoperable legacy field that is only returned for backwards compatibility.
`email`	string	@OutputOnly The email address of the service account.
`displayName`	string	Optional. A user-specified name for the service account. Must be less than or equal to 100 UTF-8 bytes.
`disabled`	boolean	@OutputOnly A bool indicate if the service account is disabled. The field is currently in alpha phase.
`description`	string	Optional. A user-specified opaque description of the service account. Must be less than or equal to 256 UTF-8 bytes.

POST

/v1/{name}:disable

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.

Request

Path

Name	Data Type	Description
`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.

Body

Name Data Type Description

DisableServiceAccountRequest


                        DisableServiceAccountRequest

object

The service account disable request.

Responses

200Successful response

Body

Name Data Type Description

Empty


                        Empty

object

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 {}.

POST

/v1/{name}:enable

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.

Request

Path

Name	Data Type	Description
`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.

Body

Name Data Type Description

EnableServiceAccountRequest


                        EnableServiceAccountRequest

object

The service account enable request.

Responses

200Successful response

Body

Name Data Type Description

Empty


                        Empty

object

service Foo {
  rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
}

The JSON representation for Empty is empty JSON object {}.

POST

/v1/{name}:signBlob

Note: This method is in the process of being deprecated. Call the signBlob() method of the Cloud IAM Service Account Credentials API instead.

Signs a blob using a service account's system-managed private key.

Request

Path

Name	Data Type	Description
`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.

Body

Name Data Type Description

SignBlobRequest


                        SignBlobRequest

object

The service account sign blob request.

Properties


                        bytesToSign

byte

Required. The bytes to sign.

Responses

200Successful response

Body

Name Data Type Description

SignBlobResponse


                        SignBlobResponse

object

The service account sign blob response.

Properties

`signature`	byte	The signed blob.
`keyId`	string	The id of the key used to sign the blob.

POST

/v1/{name}:signJwt

Note: This method is in the process of being deprecated. Call the 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.

Request

Path

Name	Data Type	Description
`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.

Body

Name Data Type Description

SignJwtRequest


                        SignJwtRequest

object

The service account sign JWT request.

Properties


                        payload

string

Required. The JWT payload to sign, a JSON JWT Claim set.

Responses

200Successful response

Body

Name Data Type Description

SignJwtResponse


                        SignJwtResponse

object

The service account sign JWT response.

Properties

`signedJwt`	string	The signed JWT.
`keyId`	string	The id of the key used to sign the JWT.

PUT

/v1/{name}

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.

Request

Path

Name	Data Type	Description
`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}`.

Body

Name Data Type Description

ServiceAccount


                        ServiceAccount

object

A service account in the Identity and Access Management API.

Properties

`uniqueId`	string	@OutputOnly The unique and stable id of the service account.
`projectId`	string	@OutputOnly The id of the project that owns the service account.
`oauth2ClientId`	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.
`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}`.
`etag`	byte	Optional. Note: `etag` is an inoperable legacy field that is only returned for backwards compatibility.
`email`	string	@OutputOnly The email address of the service account.
`displayName`	string	Optional. A user-specified name for the service account. Must be less than or equal to 100 UTF-8 bytes.
`disabled`	boolean	@OutputOnly A bool indicate if the service account is disabled. The field is currently in alpha phase.
`description`	string	Optional. A user-specified opaque description of the service account. Must be less than or equal to 256 UTF-8 bytes.

Responses

200Successful response

Body

Name Data Type Description

ServiceAccount


                        ServiceAccount

object

A service account in the Identity and Access Management API.

Properties

`uniqueId`	string	@OutputOnly The unique and stable id of the service account.
`projectId`	string	@OutputOnly The id of the project that owns the service account.
`oauth2ClientId`	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.
`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}`.
`etag`	byte	Optional. Note: `etag` is an inoperable legacy field that is only returned for backwards compatibility.
`email`	string	@OutputOnly The email address of the service account.
`displayName`	string	Optional. A user-specified name for the service account. Must be less than or equal to 100 UTF-8 bytes.
`disabled`	boolean	@OutputOnly A bool indicate if the service account is disabled. The field is currently in alpha phase.
`description`	string	Optional. A user-specified opaque description of the service account. Must be less than or equal to 256 UTF-8 bytes.

POST

/v1/{resource}:getIamPolicy

Returns the Cloud IAM access control policy for a ServiceAccount.

Note: Service accounts are both resources and identities. 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 method.

Request

Path

Name	Data Type	Description
`resource`	string	REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

Query

Name	Data Type	Description
`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.

Responses

200Successful response

Body

Name Data Type Description

Policy


                        Policy

object

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.

Properties


                        version

integer

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.


                        etag

byte

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.


                        bindings

array [Binding]

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.


                        Binding

object

Associates members with a role.

Properties

`role`	string	Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
`members`	array [string]	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`.
`condition`	Expr	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.


                        auditConfigs

array [AuditConfig]

Specifies cloud audit logging configuration for this policy.


                        AuditConfig

object

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.

Properties

`service`	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`	array [AuditLogConfig]	The configuration for logging of each type of permission.

POST

/v1/{resource}:setIamPolicy

Sets the Cloud IAM access control policy for a ServiceAccount.

Note: Service accounts are both resources and identities. 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 method.

Request

Path

Name	Data Type	Description
`resource`	string	REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

Body

Name Data Type Description

SetIamPolicyRequest


                        SetIamPolicyRequest

object

Request message for SetIamPolicy method.

Properties


                        updateMask

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.


                        policy

Policy

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.


                        Policy

object

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

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.

Properties

`version`	integer	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.
`etag`	byte	`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.
`bindings`	array [Binding]	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.
`auditConfigs`	array [AuditConfig]	Specifies cloud audit logging configuration for this policy.

Responses

200Successful response

Body

Name Data Type Description

Policy


                        Policy

object

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

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.

Properties


                        version

integer

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

If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.


                        etag

byte


                        bindings

array [Binding]

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.


                        Binding

object

Associates members with a role.

Properties

`role`	string	Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
`members`	array [string]	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`.
`condition`	Expr	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.


                        auditConfigs

array [AuditConfig]

Specifies cloud audit logging configuration for this policy.


                        AuditConfig

object

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.

Properties

`service`	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`	array [AuditLogConfig]	The configuration for logging of each type of permission.

POST

/v1/{resource}:testIamPermissions

Tests the specified permissions against the IAM access control policy for a ServiceAccount.

Request

Path

Name	Data Type	Description
`resource`	string	REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

Body

Name Data Type Description

TestIamPermissionsRequest


                        TestIamPermissionsRequest

object

Request message for TestIamPermissions method.

Properties


                        permissions

array [string]

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.

Responses

200Successful response

Body

Name Data Type Description

TestIamPermissionsResponse


                        TestIamPermissionsResponse

object

Response message for TestIamPermissions method.

Properties


                        permissions

array [string]

A subset of TestPermissionsRequest.permissions that the caller is allowed.

roles

POST

/v1/roles:queryGrantableRoles

Queries roles that can be granted on a particular resource. A role is grantable if it can be used as the role in a binding for a policy for that resource.

Request

Body

Name Data Type Description

QueryGrantableRolesRequest


                        QueryGrantableRolesRequest

object

The grantable role query request.

Properties

`view`	string Allowed values: - `BASIC` - `FULL`
`pageToken`	string	Optional pagination token returned in an earlier QueryGrantableRolesResponse.
`pageSize`	integer	Optional limit on the number of roles to include in the response.
`fullResourceName`	string	Required. The full resource name to query from the list of grantable roles. The name follows the Google Cloud Platform resource format. For example, a Cloud Platform project with id `my-project` will be named `//cloudresourcemanager.googleapis.com/projects/my-project`.

Responses

200Successful response

Body

Name Data Type Description

QueryGrantableRolesResponse


                        QueryGrantableRolesResponse

object

The grantable role query response.

Properties


                        roles

array [Role]

The list of matching roles.


                        Role

object

A role in the Identity and Access Management API.

Properties

`title`	string	Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
`stage`	string Allowed values: - `ALPHA` - `BETA` - `GA` - `DEPRECATED` - `DISABLED` - `EAP`	The current launch stage of the role. If the `ALPHA` launch stage has been selected for a role, the `stage` field will not be included in the returned definition for the role.
`name`	string	The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
`includedPermissions`	array [string]	The names of the permissions this role grants when bound in an IAM policy.
`etag`	byte	Used to perform a consistent read-modify-write.
`description`	string	Optional. A human-readable description for the role.
`deleted`	boolean	The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.


                        nextPageToken

string

To retrieve the next page of results, set QueryGrantableRolesRequest.page_token to this value.

GET

/v1/roles

Lists the Roles defined on a resource.

Request

Query

Name	Data Type	Description
`view`	string Allowed values: - `BASIC` - `FULL`	Optional view for the returned Role objects. When `FULL` is specified, the `includedPermissions` field is returned, which includes a list of all permissions in the role. The default value is `BASIC`, which does not return the `includedPermissions` field.
`showDeleted`	boolean	Include Roles that have been deleted.
`parent`	string	The `parent` parameter's value depends on the target resource for the request, namely `roles`, `projects`, or `organizations`. Each resource type's `parent` value format is described below: `roles.list()`: An empty string. This method doesn't require a resource; it simply returns all predefined roles in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles` `projects.roles.list()`: `projects/{PROJECT_ID}`. This method lists all project-level custom roles. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` `organizations.roles.list()`: `organizations/{ORGANIZATION_ID}`. This method lists all organization-level custom roles. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.
`pageToken`	string	Optional pagination token returned in an earlier ListRolesResponse.
`pageSize`	integer	Optional limit on the number of roles to include in the response.

Responses

200Successful response

Body

Name Data Type Description

ListRolesResponse


                        ListRolesResponse

object

The response containing the roles defined under a resource.

Properties


                        roles

array [Role]

The Roles defined on this resource.


                        Role

object

A role in the Identity and Access Management API.

Properties

`title`	string	Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
`stage`	string Allowed values: - `ALPHA` - `BETA` - `GA` - `DEPRECATED` - `DISABLED` - `EAP`	The current launch stage of the role. If the `ALPHA` launch stage has been selected for a role, the `stage` field will not be included in the returned definition for the role.
`name`	string	The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
`includedPermissions`	array [string]	The names of the permissions this role grants when bound in an IAM policy.
`etag`	byte	Used to perform a consistent read-modify-write.
`description`	string	Optional. A human-readable description for the role.
`deleted`	boolean	The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.


                        nextPageToken

string

To retrieve the next page of results, set ListRolesRequest.page_token to this value.

Models

AdminAuditData

AuditConfig

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.

Properties

Name Data Type Description


                        service

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

array [AuditLogConfig]

The configuration for logging of each type of permission.


                        AuditLogConfig

object

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.

Properties

`logType`	string Allowed values: - `LOG_TYPE_UNSPECIFIED` - `ADMIN_READ` - `DATA_WRITE` - `DATA_READ`	The log type that this config enables.
`exemptedMembers`	array [string]	Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

AuditData

Audit log information specific to Cloud IAM. This message is serialized as an Any type in the ServiceData message of an AuditLog message.

Properties

Name Data Type Description


                        policyDelta

PolicyDelta

Policy delta between the original policy and the newly set policy.


                        PolicyDelta

object

The difference delta between two policies.

Properties


                        bindingDeltas

array [BindingDelta]

The delta for Bindings between two policies.


                        BindingDelta

object

One delta entry for Binding. Each individual change (only one member in each entry) to a binding will be a separate entry.

Properties


                        role

string

Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner. Required


                        member

string

A single identity requesting access for a Cloud Platform resource. Follows the same format of Binding.members. Required


                        condition

Expr

The condition that is associated with this binding.


                        Expr

object

Represents an expression text. Example:

title: "User account presence"
description: "Determines whether the request has a user account"
expression: "size(request.user) > 0"

Properties

`title`	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.
`location`	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`	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`	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.


                        action

string
Allowed values:
- ACTION_UNSPECIFIED
- ADD
- REMOVE

The action that was performed on a Binding. Required

AuditLogConfig

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.

Properties

Name	Data Type	Description
`logType`	string Allowed values: - `LOG_TYPE_UNSPECIFIED` - `ADMIN_READ` - `DATA_WRITE` - `DATA_READ`	The log type that this config enables.
`exemptedMembers`	array [string]	Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

AuditableService

Binding

Associates members with a role.

Properties

Name Data Type Description


                        role

string

Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.


                        members

array [string]

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.


                        condition

Expr

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.


                        Expr

object

Represents an expression text. Example:

title: "User account presence"
description: "Determines whether the request has a user account"
expression: "size(request.user) > 0"

Properties

`title`	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.
`location`	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`	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`	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.

BindingDelta

One delta entry for Binding. Each individual change (only one member in each entry) to a binding will be a separate entry.

Properties

Name Data Type Description


                        role

string

Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner. Required


                        member

string

A single identity requesting access for a Cloud Platform resource. Follows the same format of Binding.members. Required


                        condition

Expr

The condition that is associated with this binding.


                        Expr

object

Represents an expression text. Example:

title: "User account presence"
description: "Determines whether the request has a user account"
expression: "size(request.user) > 0"

Properties

`title`	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.
`location`	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`	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`	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.


                        action

string
Allowed values:
- ACTION_UNSPECIFIED
- ADD
- REMOVE

The action that was performed on a Binding. Required

CreateRoleRequest

The request to create a new role.

Properties

Name Data Type Description


                        roleId

string

The role ID to use for this role.


                        role

Role

The Role resource to create.


                        Role

object

A role in the Identity and Access Management API.

Properties

`title`	string	Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
`stage`	string Allowed values: - `ALPHA` - `BETA` - `GA` - `DEPRECATED` - `DISABLED` - `EAP`	The current launch stage of the role. If the `ALPHA` launch stage has been selected for a role, the `stage` field will not be included in the returned definition for the role.
`name`	string	The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
`includedPermissions`	array [string]	The names of the permissions this role grants when bound in an IAM policy.
`etag`	byte	Used to perform a consistent read-modify-write.
`description`	string	Optional. A human-readable description for the role.
`deleted`	boolean	The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.

CreateServiceAccountKeyRequest

CreateServiceAccountRequest

The service account create request.

Properties

Name Data Type Description


                        serviceAccount

ServiceAccount

The ServiceAccount resource to create. Currently, only the following values are user assignable: display_name and description.


                        ServiceAccount

object

A service account in the Identity and Access Management API.

Properties

`uniqueId`	string	@OutputOnly The unique and stable id of the service account.
`projectId`	string	@OutputOnly The id of the project that owns the service account.
`oauth2ClientId`	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.
`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}`.
`etag`	byte	Optional. Note: `etag` is an inoperable legacy field that is only returned for backwards compatibility.
`email`	string	@OutputOnly The email address of the service account.
`displayName`	string	Optional. A user-specified name for the service account. Must be less than or equal to 100 UTF-8 bytes.
`disabled`	boolean	@OutputOnly A bool indicate if the service account is disabled. The field is currently in alpha phase.
`description`	string	Optional. A user-specified opaque description of the service account. Must be less than or equal to 256 UTF-8 bytes.


                        accountId

string

DisableServiceAccountRequest

Empty

service Foo {
  rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
}

The JSON representation for Empty is empty JSON object {}.

Name	Data Type	Description
`Empty`	object	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 `{}`.

EnableServiceAccountRequest

Expr

Represents an expression text. Example:

title: "User account presence"
description: "Determines whether the request has a user account"
expression: "size(request.user) > 0"

Properties

Name	Data Type	Description
`title`	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.
`location`	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`	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`	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.

LintPolicyRequest

The request to lint a Cloud IAM policy object.

Properties

Name Data Type Description


                        fullResourceName

string

The full resource name of the policy this lint request is about.

The name follows the Google Cloud Platform (GCP) resource format. For example, a GCP project with ID my-project will be named //cloudresourcemanager.googleapis.com/projects/my-project.

The resource name is not used to read the policy instance from the Cloud IAM database. The candidate policy for lint has to be provided in the same request object.


                        condition

Expr

google.iam.v1.Binding.condition object to be linted.


                        Expr

object

Represents an expression text. Example:

title: "User account presence"
description: "Determines whether the request has a user account"
expression: "size(request.user) > 0"

Properties

`title`	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.
`location`	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`	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`	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.

LintPolicyResponse

The response of a lint operation. An empty response indicates the operation was able to fully execute and no lint issue was found.

Properties

Name Data Type Description


                        lintResults

array [LintResult]

List of lint results sorted by severity in descending order.


                        LintResult

object

Structured response of a single validation unit.

Properties

`validationUnitName`	string	The validation unit name, for instance "lintValidationUnits/ConditionComplexityCheck".
`severity`	string Allowed values: - `SEVERITY_UNSPECIFIED` - `ERROR` - `WARNING` - `NOTICE` - `INFO` - `DEPRECATED`	The validation unit severity.
`locationOffset`	integer	0-based character position of problematic construct within the object identified by `field_name`. Currently, this is populated only for condition expression.
`level`	string Allowed values: - `LEVEL_UNSPECIFIED` - `CONDITION`	The validation unit level.
`fieldName`	string	The name of the field for which this lint result is about. For nested messages `field_name` consists of names of the embedded fields separated by period character. The top-level qualifier is the input object to lint in the request. For example, the `field_name` value `condition.expression` identifies a lint result for the `expression` field of the provided condition.
`debugMessage`	string	Human readable debug message associated with the issue.

LintResult

Structured response of a single validation unit.

Properties

Name	Data Type	Description
`validationUnitName`	string	The validation unit name, for instance "lintValidationUnits/ConditionComplexityCheck".
`severity`	string Allowed values: - `SEVERITY_UNSPECIFIED` - `ERROR` - `WARNING` - `NOTICE` - `INFO` - `DEPRECATED`	The validation unit severity.
`locationOffset`	integer	0-based character position of problematic construct within the object identified by `field_name`. Currently, this is populated only for condition expression.
`level`	string Allowed values: - `LEVEL_UNSPECIFIED` - `CONDITION`	The validation unit level.
`fieldName`	string	The name of the field for which this lint result is about. For nested messages `field_name` consists of names of the embedded fields separated by period character. The top-level qualifier is the input object to lint in the request. For example, the `field_name` value `condition.expression` identifies a lint result for the `expression` field of the provided condition.
`debugMessage`	string	Human readable debug message associated with the issue.

ListRolesResponse

The response containing the roles defined under a resource.

Properties

Name Data Type Description


                        roles

array [Role]

The Roles defined on this resource.


                        Role

object

A role in the Identity and Access Management API.

Properties

`title`	string	Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
`stage`	string Allowed values: - `ALPHA` - `BETA` - `GA` - `DEPRECATED` - `DISABLED` - `EAP`	The current launch stage of the role. If the `ALPHA` launch stage has been selected for a role, the `stage` field will not be included in the returned definition for the role.
`name`	string	The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
`includedPermissions`	array [string]	The names of the permissions this role grants when bound in an IAM policy.
`etag`	byte	Used to perform a consistent read-modify-write.
`description`	string	Optional. A human-readable description for the role.
`deleted`	boolean	The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.


                        nextPageToken

string

To retrieve the next page of results, set ListRolesRequest.page_token to this value.

ListServiceAccountKeysResponse

The service account keys list response.

Properties

Name Data Type Description


                        keys

array [ServiceAccountKey]

The public keys for the service account.


                        ServiceAccountKey

object

Represents a service account key.

A service account has two sets of key-pairs: user-managed, and system-managed.

Public keys for all service accounts are also published at the OAuth2 Service Account API.

Properties

`validBeforeTime`	string	The key can be used before this timestamp. For system-managed key pairs, this timestamp is the end time for the private key signing operation. The public key could still be used for verification for a few hours after this time.
`validAfterTime`	string	The key can be used after this timestamp.
`publicKeyData`	byte	The public key data. Only provided in `GetServiceAccountKey` responses.
`privateKeyType`	string Allowed values: - `TYPE_UNSPECIFIED` - `TYPE_PKCS12_FILE` - `TYPE_GOOGLE_CREDENTIALS_FILE`	The output format for the private key. Only provided in `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or `ListServiceAccountKey` responses. Google never exposes system-managed private keys, and never retains user-managed private keys.
`privateKeyData`	byte	The private key data. Only provided in `CreateServiceAccountKey` responses. Make sure to keep the private key data secure because it allows for the assertion of the service account identity. When base64 decoded, the private key data can be used to authenticate with Google API client libraries and with gcloud auth activate-service-account.
`name`	string	The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.
`keyType`	string Allowed values: - `KEY_TYPE_UNSPECIFIED` - `USER_MANAGED` - `SYSTEM_MANAGED`	The key type.
`keyOrigin`	string Allowed values: - `ORIGIN_UNSPECIFIED` - `USER_PROVIDED` - `GOOGLE_PROVIDED`	The key origin.
`keyAlgorithm`	string Allowed values: - `KEY_ALG_UNSPECIFIED` - `KEY_ALG_RSA_1024` - `KEY_ALG_RSA_2048`	Specifies the algorithm (and possibly key size) for the key.

ListServiceAccountsResponse

The service account list response.

Properties

Name Data Type Description


                        nextPageToken

string

To retrieve the next page of results, set ListServiceAccountsRequest.page_token to this value.


                        accounts

array [ServiceAccount]

The list of matching service accounts.


                        ServiceAccount

object

A service account in the Identity and Access Management API.

Properties

`uniqueId`	string	@OutputOnly The unique and stable id of the service account.
`projectId`	string	@OutputOnly The id of the project that owns the service account.
`oauth2ClientId`	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.
`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}`.
`etag`	byte	Optional. Note: `etag` is an inoperable legacy field that is only returned for backwards compatibility.
`email`	string	@OutputOnly The email address of the service account.
`displayName`	string	Optional. A user-specified name for the service account. Must be less than or equal to 100 UTF-8 bytes.
`disabled`	boolean	@OutputOnly A bool indicate if the service account is disabled. The field is currently in alpha phase.
`description`	string	Optional. A user-specified opaque description of the service account. Must be less than or equal to 256 UTF-8 bytes.

PatchServiceAccountRequest

The patch service account request.

Properties

Name Data Type Description

updateMask string

serviceAccount ServiceAccount


                        ServiceAccount

object

A service account in the Identity and Access Management API.

Properties

`uniqueId`	string	@OutputOnly The unique and stable id of the service account.
`projectId`	string	@OutputOnly The id of the project that owns the service account.
`oauth2ClientId`	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.
`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}`.
`etag`	byte	Optional. Note: `etag` is an inoperable legacy field that is only returned for backwards compatibility.
`email`	string	@OutputOnly The email address of the service account.
`displayName`	string	Optional. A user-specified name for the service account. Must be less than or equal to 100 UTF-8 bytes.
`disabled`	boolean	@OutputOnly A bool indicate if the service account is disabled. The field is currently in alpha phase.
`description`	string	Optional. A user-specified opaque description of the service account. Must be less than or equal to 256 UTF-8 bytes.

Permission

A permission which can be included by a role.

Properties

Name	Data Type	Description
`title`	string	The title of this Permission.
`stage`	string Allowed values: - `ALPHA` - `BETA` - `GA` - `DEPRECATED`	The current launch stage of the permission.
`primaryPermission`	string	The preferred name for this permission. If present, then this permission is an alias of, and equivalent to, the listed primary_permission.
`onlyInPredefinedRoles`	boolean
`name`	string	The name of this Permission.
`description`	string	A brief description of what this Permission is used for. This permission can ONLY be used in predefined roles.
`customRolesSupportLevel`	string Allowed values: - `SUPPORTED` - `TESTING` - `NOT_SUPPORTED`	The current custom role support level.
`apiDisabled`	boolean	The service API associated with the permission is not enabled.

PermissionDelta

Policy

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

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.

Properties

Name Data Type Description


                        version

integer

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

If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.


                        etag

byte


                        bindings

array [Binding]

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.


                        Binding

object

Associates members with a role.

Properties


                        role

string

Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.


                        members

array [string]

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.


                        condition

Expr


                        Expr

object

Represents an expression text. Example:

title: "User account presence"
description: "Determines whether the request has a user account"
expression: "size(request.user) > 0"

Properties

`title`	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.
`location`	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`	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`	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.


                        auditConfigs

array [AuditConfig]

Specifies cloud audit logging configuration for this policy.


                        AuditConfig

object

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.

Properties


                        service

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

array [AuditLogConfig]

The configuration for logging of each type of permission.


                        AuditLogConfig

object

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.

Properties

`logType`	string Allowed values: - `LOG_TYPE_UNSPECIFIED` - `ADMIN_READ` - `DATA_WRITE` - `DATA_READ`	The log type that this config enables.
`exemptedMembers`	array [string]	Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

PolicyDelta

The difference delta between two policies.

Properties

Name Data Type Description


                        bindingDeltas

array [BindingDelta]

The delta for Bindings between two policies.


                        BindingDelta

object

One delta entry for Binding. Each individual change (only one member in each entry) to a binding will be a separate entry.

Properties


                        role

string

Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner. Required


                        member

string

A single identity requesting access for a Cloud Platform resource. Follows the same format of Binding.members. Required


                        condition

Expr

The condition that is associated with this binding.


                        Expr

object

Represents an expression text. Example:

title: "User account presence"
description: "Determines whether the request has a user account"
expression: "size(request.user) > 0"

Properties

`title`	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.
`location`	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`	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`	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.


                        action

string
Allowed values:
- ACTION_UNSPECIFIED
- ADD
- REMOVE

The action that was performed on a Binding. Required

QueryAuditableServicesRequest

QueryAuditableServicesResponse

QueryGrantableRolesRequest

QueryGrantableRolesResponse

The grantable role query response.

Properties

Name Data Type Description


                        roles

array [Role]

The list of matching roles.


                        Role

object

A role in the Identity and Access Management API.

Properties

`title`	string	Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
`stage`	string Allowed values: - `ALPHA` - `BETA` - `GA` - `DEPRECATED` - `DISABLED` - `EAP`	The current launch stage of the role. If the `ALPHA` launch stage has been selected for a role, the `stage` field will not be included in the returned definition for the role.
`name`	string	The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
`includedPermissions`	array [string]	The names of the permissions this role grants when bound in an IAM policy.
`etag`	byte	Used to perform a consistent read-modify-write.
`description`	string	Optional. A human-readable description for the role.
`deleted`	boolean	The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.


                        nextPageToken

string

To retrieve the next page of results, set QueryGrantableRolesRequest.page_token to this value.

QueryTestablePermissionsRequest

QueryTestablePermissionsResponse

The response containing permissions which can be tested on a resource.

Properties

Name Data Type Description


                        permissions

array [Permission]

The Permissions testable on the requested resource.


                        Permission

object

A permission which can be included by a role.

Properties

`title`	string	The title of this Permission.
`stage`	string Allowed values: - `ALPHA` - `BETA` - `GA` - `DEPRECATED`	The current launch stage of the permission.
`primaryPermission`	string	The preferred name for this permission. If present, then this permission is an alias of, and equivalent to, the listed primary_permission.
`onlyInPredefinedRoles`	boolean
`name`	string	The name of this Permission.
`description`	string	A brief description of what this Permission is used for. This permission can ONLY be used in predefined roles.
`customRolesSupportLevel`	string Allowed values: - `SUPPORTED` - `TESTING` - `NOT_SUPPORTED`	The current custom role support level.
`apiDisabled`	boolean	The service API associated with the permission is not enabled.


                        nextPageToken

string

To retrieve the next page of results, set QueryTestableRolesRequest.page_token to this value.

Role

A role in the Identity and Access Management API.

Properties

Name	Data Type	Description
`title`	string	Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
`stage`	string Allowed values: - `ALPHA` - `BETA` - `GA` - `DEPRECATED` - `DISABLED` - `EAP`	The current launch stage of the role. If the `ALPHA` launch stage has been selected for a role, the `stage` field will not be included in the returned definition for the role.
`name`	string	The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
`includedPermissions`	array [string]	The names of the permissions this role grants when bound in an IAM policy.
`etag`	byte	Used to perform a consistent read-modify-write.
`description`	string	Optional. A human-readable description for the role.
`deleted`	boolean	The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.

ServiceAccount

A service account in the Identity and Access Management API.

Properties

Name	Data Type	Description
`uniqueId`	string	@OutputOnly The unique and stable id of the service account.
`projectId`	string	@OutputOnly The id of the project that owns the service account.
`oauth2ClientId`	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.
`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}`.
`etag`	byte	Optional. Note: `etag` is an inoperable legacy field that is only returned for backwards compatibility.
`email`	string	@OutputOnly The email address of the service account.
`displayName`	string	Optional. A user-specified name for the service account. Must be less than or equal to 100 UTF-8 bytes.
`disabled`	boolean	@OutputOnly A bool indicate if the service account is disabled. The field is currently in alpha phase.
`description`	string	Optional. A user-specified opaque description of the service account. Must be less than or equal to 256 UTF-8 bytes.

ServiceAccountKey

Represents a service account key.

A service account has two sets of key-pairs: user-managed, and system-managed.

Public keys for all service accounts are also published at the OAuth2 Service Account API.

Properties

Name	Data Type	Description
`validBeforeTime`	string	The key can be used before this timestamp. For system-managed key pairs, this timestamp is the end time for the private key signing operation. The public key could still be used for verification for a few hours after this time.
`validAfterTime`	string	The key can be used after this timestamp.
`publicKeyData`	byte	The public key data. Only provided in `GetServiceAccountKey` responses.
`privateKeyType`	string Allowed values: - `TYPE_UNSPECIFIED` - `TYPE_PKCS12_FILE` - `TYPE_GOOGLE_CREDENTIALS_FILE`	The output format for the private key. Only provided in `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or `ListServiceAccountKey` responses. Google never exposes system-managed private keys, and never retains user-managed private keys.
`privateKeyData`	byte	The private key data. Only provided in `CreateServiceAccountKey` responses. Make sure to keep the private key data secure because it allows for the assertion of the service account identity. When base64 decoded, the private key data can be used to authenticate with Google API client libraries and with gcloud auth activate-service-account.
`name`	string	The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.
`keyType`	string Allowed values: - `KEY_TYPE_UNSPECIFIED` - `USER_MANAGED` - `SYSTEM_MANAGED`	The key type.
`keyOrigin`	string Allowed values: - `ORIGIN_UNSPECIFIED` - `USER_PROVIDED` - `GOOGLE_PROVIDED`	The key origin.
`keyAlgorithm`	string Allowed values: - `KEY_ALG_UNSPECIFIED` - `KEY_ALG_RSA_1024` - `KEY_ALG_RSA_2048`	Specifies the algorithm (and possibly key size) for the key.

SetIamPolicyRequest

Request message for SetIamPolicy method.

Properties

Name Data Type Description


                        updateMask

string


                        policy

Policy


                        Policy

object

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

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.

Properties


                        version

integer

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

If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.


                        etag

byte


                        bindings

array [Binding]

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.


                        Binding

object

Associates members with a role.

Properties


                        role

string

Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.


                        members

array [string]

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.


                        condition

Expr


                        Expr

object

Represents an expression text. Example:

title: "User account presence"
description: "Determines whether the request has a user account"
expression: "size(request.user) > 0"

Properties

`title`	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.
`location`	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`	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`	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.


                        auditConfigs

array [AuditConfig]

Specifies cloud audit logging configuration for this policy.


                        AuditConfig

object

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.

Properties


                        service

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

array [AuditLogConfig]

The configuration for logging of each type of permission.


                        AuditLogConfig

object

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.

Properties

`logType`	string Allowed values: - `LOG_TYPE_UNSPECIFIED` - `ADMIN_READ` - `DATA_WRITE` - `DATA_READ`	The log type that this config enables.
`exemptedMembers`	array [string]	Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

SignBlobRequest

SignBlobResponse

SignJwtRequest

SignJwtResponse

TestIamPermissionsRequest

TestIamPermissionsResponse

UndeleteRoleRequest

UndeleteServiceAccountRequest

UndeleteServiceAccountResponse

Properties

Name Data Type Description


                        restoredAccount

ServiceAccount

Metadata for the restored service account.


                        ServiceAccount

object

A service account in the Identity and Access Management API.

Properties

`uniqueId`	string	@OutputOnly The unique and stable id of the service account.
`projectId`	string	@OutputOnly The id of the project that owns the service account.
`oauth2ClientId`	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.
`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}`.
`etag`	byte	Optional. Note: `etag` is an inoperable legacy field that is only returned for backwards compatibility.
`email`	string	@OutputOnly The email address of the service account.
`displayName`	string	Optional. A user-specified name for the service account. Must be less than or equal to 100 UTF-8 bytes.
`disabled`	boolean	@OutputOnly A bool indicate if the service account is disabled. The field is currently in alpha phase.
`description`	string	Optional. A user-specified opaque description of the service account. Must be less than or equal to 256 UTF-8 bytes.

UploadServiceAccountKeyRequest

Authentication

Oauth2

'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1

Oauth 2.0 accessCode authentication

Flow: authorizationCode
Authorization URL: https://accounts.google.com/o/oauth2/auth
Token URL: https://accounts.google.com/o/oauth2/token
Scopes:

https://www.googleapis.com/auth/cloud-platform: View and manage your data across Google Cloud Platform services

Oauth2

'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1

Oauth 2.0 implicit authentication

Flow: implicit
Authorization URL: https://accounts.google.com/o/oauth2/auth
Scopes:

https://www.googleapis.com/auth/cloud-platform: View and manage your data across Google Cloud Platform services

Contact

Name	`Google`
External URL	`https://google.com`

Metadata (Technical Details)

OAS (OpenAPI Specification) v3.0.0

Comments

Loading comments ...