"description":"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.",
"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"description":"The resource name of the parent resource in one of the following formats:\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
"location":"path",
"pattern":"^organizations/[^/]+$",
"required":true,
"type":"string"
}
},
"path":"v1/{+parent}/roles",
"request":{
"$ref":"CreateRoleRequest"
},
"response":{
"$ref":"Role"
},
"scopes":[
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete":{
"description":"Soft deletes a role. The role is suspended and cannot be used to create new\nIAM Policy Bindings.\nThe Role will not be included in `ListRoles()` unless `show_deleted` is set\nin the `ListRolesRequest`. The Role contains the deleted boolean set.\nExisting Bindings remains, but are inactive. The Role can be undeleted\nwithin 7 days. After 7 days the Role is deleted and all Bindings associated\nwith the role are removed.",
"description":"Used to perform a consistent read-modify-write.",
"format":"byte",
"location":"query",
"type":"string"
},
"name":{
"description":"The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
"description":"The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
"location":"path",
"pattern":"^organizations/[^/]+/roles/[^/]+$",
"required":true,
"type":"string"
}
},
"path":"v1/{+name}",
"response":{
"$ref":"Role"
},
"scopes":[
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list":{
"description":"Lists the Roles defined on a resource.",
"description":"Optional limit on the number of roles to include in the response.",
"format":"int32",
"location":"query",
"type":"integer"
},
"pageToken":{
"description":"Optional pagination token returned in an earlier ListRolesResponse.",
"location":"query",
"type":"string"
},
"parent":{
"description":"The resource name of the parent resource in one of the following formats:\n`` (empty string) -- this refers to curated roles.\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
"location":"path",
"pattern":"^organizations/[^/]+$",
"required":true,
"type":"string"
},
"showDeleted":{
"description":"Include Roles that have been deleted.",
"location":"query",
"type":"boolean"
},
"view":{
"description":"Optional view for the returned Role objects.",
"description":"The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
"location":"path",
"pattern":"^organizations/[^/]+/roles/[^/]+$",
"required":true,
"type":"string"
},
"updateMask":{
"description":"A mask describing which fields in the Role have changed.",
"format":"google-fieldmask",
"location":"query",
"type":"string"
}
},
"path":"v1/{+name}",
"request":{
"$ref":"Role"
},
"response":{
"$ref":"Role"
},
"scopes":[
"https://www.googleapis.com/auth/cloud-platform"
]
},
"undelete":{
"description":"Undelete a Role, bringing it back in its previous state.",
"description":"The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
"description":"The resource name of the parent resource in one of the following formats:\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
"location":"path",
"pattern":"^projects/[^/]+$",
"required":true,
"type":"string"
}
},
"path":"v1/{+parent}/roles",
"request":{
"$ref":"CreateRoleRequest"
},
"response":{
"$ref":"Role"
},
"scopes":[
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete":{
"description":"Soft deletes a role. The role is suspended and cannot be used to create new\nIAM Policy Bindings.\nThe Role will not be included in `ListRoles()` unless `show_deleted` is set\nin the `ListRolesRequest`. The Role contains the deleted boolean set.\nExisting Bindings remains, but are inactive. The Role can be undeleted\nwithin 7 days. After 7 days the Role is deleted and all Bindings associated\nwith the role are removed.",
"description":"Used to perform a consistent read-modify-write.",
"format":"byte",
"location":"query",
"type":"string"
},
"name":{
"description":"The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
"description":"The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
"location":"path",
"pattern":"^projects/[^/]+/roles/[^/]+$",
"required":true,
"type":"string"
}
},
"path":"v1/{+name}",
"response":{
"$ref":"Role"
},
"scopes":[
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list":{
"description":"Lists the Roles defined on a resource.",
"flatPath":"v1/projects/{projectsId}/roles",
"httpMethod":"GET",
"id":"iam.projects.roles.list",
"parameterOrder":[
"parent"
],
"parameters":{
"pageSize":{
"description":"Optional limit on the number of roles to include in the response.",
"format":"int32",
"location":"query",
"type":"integer"
},
"pageToken":{
"description":"Optional pagination token returned in an earlier ListRolesResponse.",
"location":"query",
"type":"string"
},
"parent":{
"description":"The resource name of the parent resource in one of the following formats:\n`` (empty string) -- this refers to curated roles.\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
"location":"path",
"pattern":"^projects/[^/]+$",
"required":true,
"type":"string"
},
"showDeleted":{
"description":"Include Roles that have been deleted.",
"location":"query",
"type":"boolean"
},
"view":{
"description":"Optional view for the returned Role objects.",
"description":"The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
"location":"path",
"pattern":"^projects/[^/]+/roles/[^/]+$",
"required":true,
"type":"string"
},
"updateMask":{
"description":"A mask describing which fields in the Role have changed.",
"format":"google-fieldmask",
"location":"query",
"type":"string"
}
},
"path":"v1/{+name}",
"request":{
"$ref":"Role"
},
"response":{
"$ref":"Role"
},
"scopes":[
"https://www.googleapis.com/auth/cloud-platform"
]
},
"undelete":{
"description":"Undelete a Role, bringing it back in its previous state.",
"description":"The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
"description":"The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
"description":"The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
"description":"REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"description":"Optional limit on the number of service accounts to include in the\nresponse. Further accounts can subsequently be obtained by including the\nListServiceAccountsResponse.next_page_token\nin a subsequent request.",
"format":"int32",
"location":"query",
"type":"integer"
},
"pageToken":{
"description":"Optional pagination token returned in an earlier\nListServiceAccountsResponse.next_page_token.",
"description":"REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"description":"The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
"description":"Signs a JWT using a service account's system-managed private key.\n\nIf no expiry time (`exp`) is provided in the `SignJwtRequest`, IAM sets an\nan expiry time of one hour by default. If you request an expiry time of\nmore than one hour, the request will fail.",
"description":"The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
"description":"REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"description":"The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\n\nRequests using `-` as a wildcard for the `PROJECT_ID` will infer the\nproject from the `account` and the `ACCOUNT` value can be the `email`\naddress or the `unique_id` of the service account.\n\nIn responses the resource name will always be in the format\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.",
"description":"The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
"description":"The resource name of the service account key in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
"description":"The resource name of the service account key in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.\n\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
"description":"Filters the types of keys the user wants to include in the list\nresponse. Duplicate key types are not allowed. If no key type\nis provided, all keys are returned.",
"description":"The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\n\nUsing `-` as a wildcard for the `PROJECT_ID`, will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
"description":"The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
"location":"path",
"pattern":"^roles/[^/]+$",
"required":true,
"type":"string"
}
},
"path":"v1/{+name}",
"response":{
"$ref":"Role"
},
"scopes":[
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list":{
"description":"Lists the Roles defined on a resource.",
"flatPath":"v1/roles",
"httpMethod":"GET",
"id":"iam.roles.list",
"parameterOrder":[],
"parameters":{
"pageSize":{
"description":"Optional limit on the number of roles to include in the response.",
"format":"int32",
"location":"query",
"type":"integer"
},
"pageToken":{
"description":"Optional pagination token returned in an earlier ListRolesResponse.",
"location":"query",
"type":"string"
},
"parent":{
"description":"The resource name of the parent resource in one of the following formats:\n`` (empty string) -- this refers to curated roles.\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
"location":"query",
"type":"string"
},
"showDeleted":{
"description":"Include Roles that have been deleted.",
"location":"query",
"type":"boolean"
},
"view":{
"description":"Optional view for the returned Role objects.",
"enum":[
"BASIC",
"FULL"
],
"location":"query",
"type":"string"
}
},
"path":"v1/roles",
"response":{
"$ref":"ListRolesResponse"
},
"scopes":[
"https://www.googleapis.com/auth/cloud-platform"
]
},
"queryGrantableRoles":{
"description":"Queries roles that can be granted on a particular resource.\nA role is grantable if it can be used as the role in a binding for a policy\nfor that resource.",
"flatPath":"v1/roles:queryGrantableRoles",
"httpMethod":"POST",
"id":"iam.roles.queryGrantableRoles",
"parameterOrder":[],
"parameters":{},
"path":"v1/roles:queryGrantableRoles",
"request":{
"$ref":"QueryGrantableRolesRequest"
},
"response":{
"$ref":"QueryGrantableRolesResponse"
},
"scopes":[
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
},
"revision":"20180223",
"rootUrl":"https://iam.googleapis.com/",
"schemas":{
"AuditConfig":{
"description":"Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
"id":"AuditConfig",
"properties":{
"auditLogConfigs":{
"description":"The configuration for logging of each type of permission.\nNext ID: 4",
"items":{
"$ref":"AuditLogConfig"
},
"type":"array"
},
"service":{
"description":"Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
"type":"string"
}
},
"type":"object"
},
"AuditData":{
"description":"Audit log information specific to Cloud IAM. This message is serialized\nas an `Any` type in the `ServiceData` message of an\n`AuditLog` message.",
"id":"AuditData",
"properties":{
"policyDelta":{
"$ref":"PolicyDelta",
"description":"Policy delta between the original policy and the newly set policy."
}
},
"type":"object"
},
"AuditLogConfig":{
"description":"Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
"id":"AuditLogConfig",
"properties":{
"exemptedMembers":{
"description":"Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
"items":{
"type":"string"
},
"type":"array"
},
"logType":{
"description":"The log type that this config enables.",
"enum":[
"LOG_TYPE_UNSPECIFIED",
"ADMIN_READ",
"DATA_WRITE",
"DATA_READ"
],
"enumDescriptions":[
"Default case. Should never be this.",
"Admin reads. Example: CloudIAM getIamPolicy",
"Data writes. Example: CloudSQL Users create",
"Data reads. Example: CloudSQL Users list"
],
"type":"string"
}
},
"type":"object"
},
"AuditableService":{
"description":"Contains information about an auditable service.",
"id":"AuditableService",
"properties":{
"name":{
"description":"Public name of the service.\nFor example, the service name for Cloud IAM is 'iam.googleapis.com'.",
"type":"string"
}
},
"type":"object"
},
"Binding":{
"description":"Associates `members` with a `role`.",
"id":"Binding",
"properties":{
"members":{
"description":"Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
"items":{
"type":"string"
},
"type":"array"
},
"role":{
"description":"Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
"type":"string"
}
},
"type":"object"
},
"BindingDelta":{
"description":"One delta entry for Binding. Each individual change (only one member in each\nentry) to a binding will be a separate entry.",
"id":"BindingDelta",
"properties":{
"action":{
"description":"The action that was performed on a Binding.\nRequired",
"enum":[
"ACTION_UNSPECIFIED",
"ADD",
"REMOVE"
],
"enumDescriptions":[
"Unspecified.",
"Addition of a Binding.",
"Removal of a Binding."
],
"type":"string"
},
"member":{
"description":"A single identity requesting access for a Cloud Platform resource.\nFollows the same format of Binding.members.\nRequired",
"type":"string"
},
"role":{
"description":"Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
"type":"string"
}
},
"type":"object"
},
"CreateRoleRequest":{
"description":"The request to create a new role.",
"id":"CreateRoleRequest",
"properties":{
"role":{
"$ref":"Role",
"description":"The Role resource to create."
},
"roleId":{
"description":"The role id to use for this role.",
"type":"string"
}
},
"type":"object"
},
"CreateServiceAccountKeyRequest":{
"description":"The service account key create request.",
"id":"CreateServiceAccountKeyRequest",
"properties":{
"keyAlgorithm":{
"description":"Which type of key and algorithm to use for the key.\nThe default is currently a 2K RSA key. However this may change in the\nfuture.",
"enum":[
"KEY_ALG_UNSPECIFIED",
"KEY_ALG_RSA_1024",
"KEY_ALG_RSA_2048"
],
"enumDescriptions":[
"An unspecified key algorithm.",
"1k RSA Key.",
"2k RSA Key."
],
"type":"string"
},
"privateKeyType":{
"description":"The output format of the private key. The default value is\n`TYPE_GOOGLE_CREDENTIALS_FILE`, which is the Google Credentials File\nformat.",
"enum":[
"TYPE_UNSPECIFIED",
"TYPE_PKCS12_FILE",
"TYPE_GOOGLE_CREDENTIALS_FILE"
],
"enumDescriptions":[
"Unspecified. Equivalent to `TYPE_GOOGLE_CREDENTIALS_FILE`.",
"PKCS12 format.\nThe password for the PKCS12 file is `notasecret`.\nFor more information, see https://tools.ietf.org/html/rfc7292.",
"Google Credentials File format."
],
"type":"string"
}
},
"type":"object"
},
"CreateServiceAccountRequest":{
"description":"The service account create request.",
"id":"CreateServiceAccountRequest",
"properties":{
"accountId":{
"description":"Required. The account id that is used to generate the service account\nemail address and a stable unique id. It is unique within a project,\nmust be 6-30 characters long, and match the regular expression\n`[a-z]([-a-z0-9]*[a-z0-9])` to comply with RFC1035.",
"type":"string"
},
"serviceAccount":{
"$ref":"ServiceAccount",
"description":"The ServiceAccount resource to create.\nCurrently, only the following values are user assignable:\n`display_name` ."
}
},
"type":"object"
},
"Empty":{
"description":"A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"id":"Empty",
"properties":{},
"type":"object"
},
"ListRolesResponse":{
"description":"The response containing the roles defined under a resource.",
"id":"ListRolesResponse",
"properties":{
"nextPageToken":{
"description":"To retrieve the next page of results, set\n`ListRolesRequest.page_token` to this value.",
"type":"string"
},
"roles":{
"description":"The Roles defined on this resource.",
"items":{
"$ref":"Role"
},
"type":"array"
}
},
"type":"object"
},
"ListServiceAccountKeysResponse":{
"description":"The service account keys list response.",
"id":"ListServiceAccountKeysResponse",
"properties":{
"keys":{
"description":"The public keys for the service account.",
"items":{
"$ref":"ServiceAccountKey"
},
"type":"array"
}
},
"type":"object"
},
"ListServiceAccountsResponse":{
"description":"The service account list response.",
"id":"ListServiceAccountsResponse",
"properties":{
"accounts":{
"description":"The list of matching service accounts.",
"description":"To retrieve the next page of results, set\nListServiceAccountsRequest.page_token\nto this value.",
"type":"string"
}
},
"type":"object"
},
"Permission":{
"description":"A permission which can be included by a role.",
"id":"Permission",
"properties":{
"apiDisabled":{
"description":"The service API associated with the permission is not enabled.",
"type":"boolean"
},
"customRolesSupportLevel":{
"description":"The current custom role support level.",
"enum":[
"SUPPORTED",
"TESTING",
"NOT_SUPPORTED"
],
"enumDescriptions":[
"Permission is fully supported for custom role use.",
"Permission is being tested to check custom role compatibility.",
"Permission is not supported for custom role use."
],
"type":"string"
},
"description":{
"description":"A brief description of what this Permission is used for.",
"type":"string"
},
"name":{
"description":"The name of this Permission.",
"type":"string"
},
"onlyInPredefinedRoles":{
"description":"This permission can ONLY be used in predefined roles.",
"type":"boolean"
},
"stage":{
"description":"The current launch stage of the permission.",
"enum":[
"ALPHA",
"BETA",
"GA",
"DEPRECATED"
],
"enumDescriptions":[
"The permission is currently in an alpha phase.",
"The permission is currently in a beta phase.",
"The permission is generally available.",
"The permission is being deprecated."
],
"type":"string"
},
"title":{
"description":"The title of this Permission.",
"type":"string"
}
},
"type":"object"
},
"Policy":{
"description":"Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
"id":"Policy",
"properties":{
"auditConfigs":{
"description":"Specifies cloud audit logging configuration for this policy.",
"items":{
"$ref":"AuditConfig"
},
"type":"array"
},
"bindings":{
"description":"Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
"items":{
"$ref":"Binding"
},
"type":"array"
},
"etag":{
"description":"`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
"description":"A request to get the list of auditable services for a resource.",
"id":"QueryAuditableServicesRequest",
"properties":{
"fullResourceName":{
"description":"Required. The full resource name to query from the list of auditable\nservices.\n\nThe name follows the Google Cloud Platform resource format.\nFor example, a Cloud Platform project with id `my-project` will be named\n`//cloudresourcemanager.googleapis.com/projects/my-project`.",
"type":"string"
}
},
"type":"object"
},
"QueryAuditableServicesResponse":{
"description":"A response containing a list of auditable services for a resource.",
"id":"QueryAuditableServicesResponse",
"properties":{
"services":{
"description":"The auditable services for a resource.",
"description":"The grantable role query request.",
"id":"QueryGrantableRolesRequest",
"properties":{
"fullResourceName":{
"description":"Required. The full resource name to query from the list of grantable roles.\n\nThe name follows the Google Cloud Platform resource format.\nFor example, a Cloud Platform project with id `my-project` will be named\n`//cloudresourcemanager.googleapis.com/projects/my-project`.",
"type":"string"
},
"pageSize":{
"description":"Optional limit on the number of roles to include in the response.",
"format":"int32",
"type":"integer"
},
"pageToken":{
"description":"Optional pagination token returned in an earlier\nQueryGrantableRolesResponse.",
"description":"A request to get permissions which can be tested on a resource.",
"id":"QueryTestablePermissionsRequest",
"properties":{
"fullResourceName":{
"description":"Required. The full resource name to query from the list of testable\npermissions.\n\nThe name follows the Google Cloud Platform resource format.\nFor example, a Cloud Platform project with id `my-project` will be named\n`//cloudresourcemanager.googleapis.com/projects/my-project`.",
"type":"string"
},
"pageSize":{
"description":"Optional limit on the number of permissions to include in the response.",
"format":"int32",
"type":"integer"
},
"pageToken":{
"description":"Optional pagination token returned in an earlier\nQueryTestablePermissionsRequest.",
"type":"string"
}
},
"type":"object"
},
"QueryTestablePermissionsResponse":{
"description":"The response containing permissions which can be tested on a resource.",
"id":"QueryTestablePermissionsResponse",
"properties":{
"nextPageToken":{
"description":"To retrieve the next page of results, set\n`QueryTestableRolesRequest.page_token` to this value.",
"type":"string"
},
"permissions":{
"description":"The Permissions testable on the requested resource.",
"description":"A role in the Identity and Access Management API.",
"id":"Role",
"properties":{
"deleted":{
"description":"The current deleted state of the role. This field is read only.\nIt will be ignored in calls to CreateRole and UpdateRole.",
"type":"boolean"
},
"description":{
"description":"Optional. A human-readable description for the role.",
"type":"string"
},
"etag":{
"description":"Used to perform a consistent read-modify-write.",
"format":"byte",
"type":"string"
},
"includedPermissions":{
"description":"The names of the permissions this role grants when bound in an IAM policy.",
"items":{
"type":"string"
},
"type":"array"
},
"name":{
"description":"The name of the role.\n\nWhen Role is used in CreateRole, the role name must not be set.\n\nWhen Role is used in output and other input such as UpdateRole, the role\nname is the complete path, e.g., roles/logging.viewer for curated roles\nand organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.",
"type":"string"
},
"stage":{
"description":"The current launch stage of the role.",
"enum":[
"ALPHA",
"BETA",
"GA",
"DEPRECATED",
"DISABLED",
"EAP"
],
"enumDescriptions":[
"The user has indicated this role is currently in an alpha phase.",
"The user has indicated this role is currently in a beta phase.",
"The user has indicated this role is generally available.",
"The user has indicated this role is being deprecated.",
"This role is disabled and will not contribute permissions to any members\nit is granted to in policies.",
"The user has indicated this role is currently in an eap phase."
],
"type":"string"
},
"title":{
"description":"Optional. A human-readable title for the role. Typically this\nis limited to 100 UTF-8 bytes.",
"type":"string"
}
},
"type":"object"
},
"ServiceAccount":{
"description":"A service account in the Identity and Access Management API.\n\nTo create a service account, specify the `project_id` and the `account_id`\nfor the account. The `account_id` is unique within the project, and is used\nto generate the service account email address and a stable\n`unique_id`.\n\nIf the account already exists, the account's resource name is returned\nin the format of projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. The caller\ncan use the name in other methods to access the account.\n\nAll other methods can identify the service account using the format\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
"id":"ServiceAccount",
"properties":{
"displayName":{
"description":"Optional. A user-specified description of the service account. Must be\nfewer than 100 UTF-8 bytes.",
"type":"string"
},
"email":{
"description":"@OutputOnly The email address of the service account.",
"type":"string"
},
"etag":{
"description":"Used to perform a consistent read-modify-write.",
"format":"byte",
"type":"string"
},
"name":{
"description":"The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\n\nRequests using `-` as a wildcard for the `PROJECT_ID` will infer the\nproject from the `account` and the `ACCOUNT` value can be the `email`\naddress or the `unique_id` of the service account.\n\nIn responses the resource name will always be in the format\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.",
"type":"string"
},
"oauth2ClientId":{
"description":"@OutputOnly The OAuth2 client id for the service account.\nThis is used in conjunction with the OAuth2 clientconfig API to make\nthree legged OAuth2 (3LO) flows to access the data of Google users.",
"type":"string"
},
"projectId":{
"description":"@OutputOnly The id of the project that owns the service account.",
"type":"string"
},
"uniqueId":{
"description":"@OutputOnly The unique and stable id of the service account.",
"type":"string"
}
},
"type":"object"
},
"ServiceAccountKey":{
"description":"Represents a service account key.\n\nA service account has two sets of key-pairs: user-managed, and\nsystem-managed.\n\nUser-managed key-pairs can be created and deleted by users. Users are\nresponsible for rotating these keys periodically to ensure security of\ntheir service accounts. Users retain the private key of these key-pairs,\nand Google retains ONLY the public key.\n\nSystem-managed key-pairs are managed automatically by Google, and rotated\ndaily without user intervention. The private key never leaves Google's\nservers to maximize security.\n\nPublic keys for all service accounts are also published at the OAuth2\nService Account API.",
"id":"ServiceAccountKey",
"properties":{
"keyAlgorithm":{
"description":"Specifies the algorithm (and possibly key size) for the key.",
"description":"The resource name of the service account key in the following format\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.",
"type":"string"
},
"privateKeyData":{
"description":"The private key data. Only provided in `CreateServiceAccountKey`\nresponses. Make sure to keep the private key data secure because it\nallows for the assertion of the service account identity.\nWhen base64 decoded, the private key data can be used to authenticate with\nGoogle API client libraries and with\n\u003ca href=\"/sdk/gcloud/reference/auth/activate-service-account\"\u003egcloud\nauth activate-service-account\u003c/a\u003e.",
"format":"byte",
"type":"string"
},
"privateKeyType":{
"description":"The output format for the private key.\nOnly provided in `CreateServiceAccountKey` responses, not\nin `GetServiceAccountKey` or `ListServiceAccountKey` responses.\n\nGoogle never exposes system-managed private keys, and never retains\nuser-managed private keys.",
"description":"Request message for `SetIamPolicy` method.",
"id":"SetIamPolicyRequest",
"properties":{
"policy":{
"$ref":"Policy",
"description":"REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
},
"updateMask":{
"description":"OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
"description":"Request message for `TestIamPermissions` method.",
"id":"TestIamPermissionsRequest",
"properties":{
"permissions":{
"description":"The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
