blob: f75b0f70e42a3ef57bf8410887e36b4d51c529bd [file] [log] [blame]
{
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
"ListServiceAccountsResponse": {
"properties": {
"nextPageToken": {
"description": "To retrieve the next page of results, set\nListServiceAccountsRequest.page_token\nto this value.",
"type": "string"
},
"accounts": {
"description": "The list of matching service accounts.",
"items": {
"$ref": "ServiceAccount"
},
"type": "array"
}
},
"id": "ListServiceAccountsResponse",
"description": "The service account list response.",
"type": "object"
},
"QueryGrantableRolesResponse": {
"properties": {
"nextPageToken": {
"description": "To retrieve the next page of results, set\n`QueryGrantableRolesRequest.page_token` to this value.",
"type": "string"
},
"roles": {
"description": "The list of matching roles.",
"items": {
"$ref": "Role"
},
"type": "array"
}
},
"id": "QueryGrantableRolesResponse",
"description": "The grantable role query response.",
"type": "object"
},
"SignBlobRequest": {
"description": "The service account sign blob request.",
"type": "object",
"properties": {
"bytesToSign": {
"format": "byte",
"description": "The bytes to sign.",
"type": "string"
}
},
"id": "SignBlobRequest"
},
"SetIamPolicyRequest": {
"description": "Request message for `SetIamPolicy` method.",
"type": "object",
"properties": {
"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.",
"$ref": "Policy"
}
},
"id": "SetIamPolicyRequest"
},
"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.",
"items": {
"$ref": "Permission"
},
"type": "array"
}
},
"id": "QueryTestablePermissionsResponse",
"description": "The response containing permissions which can be tested on a resource.",
"type": "object"
},
"Empty": {
"properties": {},
"id": "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 `{}`.",
"type": "object"
},
"CreateServiceAccountKeyRequest": {
"description": "The service account key create request.",
"type": "object",
"properties": {
"keyAlgorithm": {
"enum": [
"KEY_ALG_UNSPECIFIED",
"KEY_ALG_RSA_1024",
"KEY_ALG_RSA_2048"
],
"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.",
"type": "string",
"enumDescriptions": [
"An unspecified key algorithm.",
"1k RSA Key.",
"2k RSA Key."
]
},
"privateKeyType": {
"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."
],
"enum": [
"TYPE_UNSPECIFIED",
"TYPE_PKCS12_FILE",
"TYPE_GOOGLE_CREDENTIALS_FILE"
],
"description": "The output format of the private key. `GOOGLE_CREDENTIALS_FILE` is the\ndefault output format.",
"type": "string"
}
},
"id": "CreateServiceAccountKeyRequest"
},
"SignJwtResponse": {
"properties": {
"signedJwt": {
"description": "The signed JWT.",
"type": "string"
},
"keyId": {
"description": "The id of the key used to sign the JWT.",
"type": "string"
}
},
"id": "SignJwtResponse",
"description": "The service account sign JWT response.",
"type": "object"
},
"TestIamPermissionsRequest": {
"description": "Request message for `TestIamPermissions` method.",
"type": "object",
"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).",
"items": {
"type": "string"
},
"type": "array"
}
},
"id": "TestIamPermissionsRequest"
},
"Policy": {
"properties": {
"etag": {
"format": "byte",
"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.",
"type": "string"
},
"version": {
"format": "int32",
"description": "Version of the `Policy`. The default version is 0.",
"type": "integer"
},
"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"
}
},
"id": "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).",
"type": "object"
},
"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"
}
},
"id": "ListRolesResponse",
"description": "The response containing the roles defined under a resource.",
"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.",
"type": "object",
"properties": {
"policyDelta": {
"$ref": "PolicyDelta",
"description": "Policy delta between the original policy and the newly set policy."
}
},
"id": "AuditData"
},
"BindingDelta": {
"description": "One delta entry for Binding. Each individual change (only one member in each\nentry) to a binding will be a separate entry.",
"type": "object",
"properties": {
"action": {
"enumDescriptions": [
"Unspecified.",
"Addition of a Binding.",
"Removal of a Binding."
],
"enum": [
"ACTION_UNSPECIFIED",
"ADD",
"REMOVE"
],
"description": "The action that was performed on a Binding.\nRequired",
"type": "string"
},
"condition": {
"description": "The condition that is associated with this binding.\nThis field is GOOGLE_INTERNAL.\nThis field is not logged in IAM side because it's only for audit logging.\nOptional",
"$ref": "Expr"
},
"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"
}
},
"id": "BindingDelta"
},
"UndeleteRoleRequest": {
"description": "The request to undelete an existing role.",
"type": "object",
"properties": {
"etag": {
"format": "byte",
"description": "Used to perform a consistent read-modify-write.",
"type": "string"
}
},
"id": "UndeleteRoleRequest"
},
"CreateServiceAccountRequest": {
"properties": {
"serviceAccount": {
"$ref": "ServiceAccount",
"description": "The ServiceAccount resource to create.\nCurrently, only the following values are user assignable:\n`display_name` ."
},
"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"
}
},
"id": "CreateServiceAccountRequest",
"description": "The service account create request.",
"type": "object"
},
"Role": {
"properties": {
"etag": {
"format": "byte",
"description": "Used to perform a consistent read-modify-write.",
"type": "string"
},
"stage": {
"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."
],
"enum": [
"ALPHA",
"BETA",
"GA",
"DEPRECATED",
"DISABLED",
"EAP"
],
"description": "The current launch stage of the role.",
"type": "string"
},
"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"
},
"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"
},
"title": {
"description": "Optional. A human-readable title for the role. Typically this\nis limited to 100 UTF-8 bytes.",
"type": "string"
},
"includedPermissions": {
"description": "The names of the permissions this role grants when bound in an IAM policy.",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"description": "Optional. A human-readable description for the role.",
"type": "string"
}
},
"id": "Role",
"description": "A role in the Identity and Access Management API.",
"type": "object"
},
"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"
}
},
"id": "Binding",
"description": "Associates `members` with a `role`.",
"type": "object"
},
"QueryGrantableRolesRequest": {
"description": "The grantable role query request.",
"type": "object",
"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"
},
"pageToken": {
"description": "Optional pagination token returned in an earlier\nQueryGrantableRolesResponse.",
"type": "string"
},
"pageSize": {
"format": "int32",
"description": "Optional limit on the number of roles to include in the response.",
"type": "integer"
},
"view": {
"enum": [
"BASIC",
"FULL"
],
"type": "string",
"enumDescriptions": [
"Omits the `included_permissions` field.\nThis is the default value.",
"Returns all fields."
]
}
},
"id": "QueryGrantableRolesRequest"
},
"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 util::Status's ResourceInfo.resource_name in the format of\nprojects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. The caller can\nuse 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.",
"type": "object",
"properties": {
"email": {
"description": "@OutputOnly The email address of the service account.",
"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"
},
"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"
},
"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"
},
"displayName": {
"description": "Optional. A user-specified description of the service account. Must be\nfewer than 100 UTF-8 bytes.",
"type": "string"
},
"etag": {
"format": "byte",
"description": "Used to perform a consistent read-modify-write.",
"type": "string"
}
},
"id": "ServiceAccount"
},
"Expr": {
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
"type": "object",
"properties": {
"description": {
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
"type": "string"
},
"expression": {
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
"type": "string"
},
"location": {
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
"type": "string"
},
"title": {
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
"type": "string"
}
},
"id": "Expr"
},
"CreateRoleRequest": {
"properties": {
"roleId": {
"description": "The role id to use for this role.",
"type": "string"
},
"role": {
"description": "The Role resource to create.",
"$ref": "Role"
}
},
"id": "CreateRoleRequest",
"description": "The request to create a new role.",
"type": "object"
},
"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"
},
"pageToken": {
"description": "Optional pagination token returned in an earlier\nQueryTestablePermissionsRequest.",
"type": "string"
},
"pageSize": {
"format": "int32",
"description": "Optional limit on the number of permissions to include in the response.",
"type": "integer"
}
},
"id": "QueryTestablePermissionsRequest",
"description": "A request to get permissions which can be tested on a resource.",
"type": "object"
},
"TestIamPermissionsResponse": {
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
"items": {
"type": "string"
},
"type": "array"
}
},
"id": "TestIamPermissionsResponse",
"description": "Response message for `TestIamPermissions` method.",
"type": "object"
},
"ListServiceAccountKeysResponse": {
"description": "The service account keys list response.",
"type": "object",
"properties": {
"keys": {
"description": "The public keys for the service account.",
"items": {
"$ref": "ServiceAccountKey"
},
"type": "array"
}
},
"id": "ListServiceAccountKeysResponse"
},
"ServiceAccountKey": {
"properties": {
"privateKeyType": {
"enum": [
"TYPE_UNSPECIFIED",
"TYPE_PKCS12_FILE",
"TYPE_GOOGLE_CREDENTIALS_FILE"
],
"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.",
"type": "string",
"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."
]
},
"validAfterTime": {
"format": "google-datetime",
"description": "The key can be used after this timestamp.",
"type": "string"
},
"privateKeyData": {
"format": "byte",
"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 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.",
"type": "string"
},
"publicKeyData": {
"format": "byte",
"description": "The public key data. Only provided in `GetServiceAccountKey` responses.",
"type": "string"
},
"name": {
"description": "The resource name of the service account key in the following format\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.",
"type": "string"
},
"validBeforeTime": {
"format": "google-datetime",
"description": "The key can be used before this timestamp.",
"type": "string"
},
"keyAlgorithm": {
"enumDescriptions": [
"An unspecified key algorithm.",
"1k RSA Key.",
"2k RSA Key."
],
"enum": [
"KEY_ALG_UNSPECIFIED",
"KEY_ALG_RSA_1024",
"KEY_ALG_RSA_2048"
],
"description": "Specifies the algorithm (and possibly key size) for the key.",
"type": "string"
}
},
"id": "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.",
"type": "object"
},
"SignBlobResponse": {
"properties": {
"keyId": {
"description": "The id of the key used to sign the blob.",
"type": "string"
},
"signature": {
"format": "byte",
"description": "The signed blob.",
"type": "string"
}
},
"id": "SignBlobResponse",
"description": "The service account sign blob response.",
"type": "object"
},
"Permission": {
"properties": {
"stage": {
"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."
],
"enum": [
"ALPHA",
"BETA",
"GA",
"DEPRECATED"
],
"description": "The current launch stage of the permission.",
"type": "string"
},
"name": {
"description": "The name of this Permission.",
"type": "string"
},
"onlyInPredefinedRoles": {
"description": "This permission can ONLY be used in predefined roles.",
"type": "boolean"
},
"title": {
"description": "The title of this Permission.",
"type": "string"
},
"description": {
"description": "A brief description of what this Permission is used for.",
"type": "string"
},
"customRolesSupportLevel": {
"enum": [
"SUPPORTED",
"TESTING",
"NOT_SUPPORTED"
],
"description": "The current custom role support level.",
"type": "string",
"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."
]
}
},
"id": "Permission",
"description": "A permission which can be included by a role.",
"type": "object"
},
"SignJwtRequest": {
"description": "The service account sign JWT request.",
"type": "object",
"properties": {
"payload": {
"description": "The JWT payload to sign, a JSON JWT Claim set.",
"type": "string"
}
},
"id": "SignJwtRequest"
},
"PolicyDelta": {
"description": "The difference delta between two policies.",
"type": "object",
"properties": {
"bindingDeltas": {
"description": "The delta for Bindings between two policies.",
"items": {
"$ref": "BindingDelta"
},
"type": "array"
}
},
"id": "PolicyDelta"
}
},
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"protocol": "rest",
"canonicalName": "iam",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"rootUrl": "https://iam.googleapis.com/",
"ownerDomain": "google.com",
"name": "iam",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Google Identity and Access Management (IAM) API",
"ownerName": "Google",
"resources": {
"projects": {
"resources": {
"roles": {
"methods": {
"create": {
"id": "iam.projects.roles.create",
"path": "v1/{+parent}/roles",
"request": {
"$ref": "CreateRoleRequest"
},
"description": "Creates a new Role.",
"response": {
"$ref": "Role"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"pattern": "^projects/[^/]+$",
"location": "path",
"description": "The resource name of the parent resource in one of the following formats:\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
"type": "string",
"required": true
}
},
"flatPath": "v1/projects/{projectsId}/roles"
},
"patch": {
"httpMethod": "PATCH",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Role"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"updateMask": {
"location": "query",
"format": "google-fieldmask",
"description": "A mask describing which fields in the Role have changed.",
"type": "string"
},
"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}`",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/roles/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/projects/{projectsId}/roles/{rolesId}",
"path": "v1/{+name}",
"id": "iam.projects.roles.patch",
"request": {
"$ref": "Role"
},
"description": "Updates a Role definition."
},
"undelete": {
"httpMethod": "POST",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Role"
},
"parameters": {
"name": {
"pattern": "^projects/[^/]+/roles/[^/]+$",
"location": "path",
"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}`",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/roles/{rolesId}:undelete",
"path": "v1/{+name}:undelete",
"id": "iam.projects.roles.undelete",
"description": "Undelete a Role, bringing it back in its previous state.",
"request": {
"$ref": "UndeleteRoleRequest"
}
},
"get": {
"description": "Gets a Role definition.",
"response": {
"$ref": "Role"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"pattern": "^projects/[^/]+/roles/[^/]+$",
"location": "path",
"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}`",
"type": "string",
"required": true
}
},
"flatPath": "v1/projects/{projectsId}/roles/{rolesId}",
"id": "iam.projects.roles.get",
"path": "v1/{+name}"
},
"delete": {
"response": {
"$ref": "Role"
},
"parameterOrder": [
"name"
],
"httpMethod": "DELETE",
"parameters": {
"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}`",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/roles/[^/]+$",
"location": "path"
},
"etag": {
"location": "query",
"format": "byte",
"description": "Used to perform a consistent read-modify-write.",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/roles/{rolesId}",
"id": "iam.projects.roles.delete",
"path": "v1/{+name}",
"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."
},
"list": {
"response": {
"$ref": "ListRolesResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"parameters": {
"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}`",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+$",
"location": "path"
},
"showDeleted": {
"location": "query",
"description": "Include Roles that have been deleted.",
"type": "boolean"
},
"pageToken": {
"description": "Optional pagination token returned in an earlier ListRolesResponse.",
"type": "string",
"location": "query"
},
"pageSize": {
"format": "int32",
"description": "Optional limit on the number of roles to include in the response.",
"type": "integer",
"location": "query"
},
"view": {
"enum": [
"BASIC",
"FULL"
],
"description": "Optional view for the returned Role objects.",
"type": "string",
"location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/roles",
"id": "iam.projects.roles.list",
"path": "v1/{+parent}/roles",
"description": "Lists the Roles defined on a resource."
}
}
},
"serviceAccounts": {
"methods": {
"delete": {
"httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
"parameters": {
"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.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}",
"path": "v1/{+name}",
"id": "iam.projects.serviceAccounts.delete",
"description": "Deletes a ServiceAccount."
},
"signBlob": {
"description": "Signs a blob using a service account's system-managed private key.",
"request": {
"$ref": "SignBlobRequest"
},
"httpMethod": "POST",
"parameterOrder": [
"name"
],
"response": {
"$ref": "SignBlobResponse"
},
"parameters": {
"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.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signBlob",
"path": "v1/{+name}:signBlob",
"id": "iam.projects.serviceAccounts.signBlob"
},
"list": {
"httpMethod": "GET",
"response": {
"$ref": "ListServiceAccountsResponse"
},
"parameterOrder": [
"name"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"pageToken": {
"description": "Optional pagination token returned in an earlier\nListServiceAccountsResponse.next_page_token.",
"type": "string",
"location": "query"
},
"name": {
"description": "Required. The resource name of the project associated with the service\naccounts, such as `projects/my-project-123`.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+$",
"location": "path"
},
"pageSize": {
"location": "query",
"format": "int32",
"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.",
"type": "integer"
}
},
"flatPath": "v1/projects/{projectsId}/serviceAccounts",
"path": "v1/{+name}/serviceAccounts",
"id": "iam.projects.serviceAccounts.list",
"description": "Lists ServiceAccounts for a project."
},
"setIamPolicy": {
"path": "v1/{+resource}:setIamPolicy",
"id": "iam.projects.serviceAccounts.setIamPolicy",
"description": "Sets the IAM access control policy for a\nServiceAccount.",
"request": {
"$ref": "SetIamPolicyRequest"
},
"httpMethod": "POST",
"parameterOrder": [
"resource"
],
"response": {
"$ref": "Policy"
},
"parameters": {
"resource": {
"pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
"location": "path",
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:setIamPolicy"
},
"signJwt": {
"id": "iam.projects.serviceAccounts.signJwt",
"path": "v1/{+name}:signJwt",
"request": {
"$ref": "SignJwtRequest"
},
"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.",
"response": {
"$ref": "SignJwtResponse"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"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.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signJwt"
},
"create": {
"id": "iam.projects.serviceAccounts.create",
"path": "v1/{+name}/serviceAccounts",
"request": {
"$ref": "CreateServiceAccountRequest"
},
"description": "Creates a ServiceAccount\nand returns it.",
"response": {
"$ref": "ServiceAccount"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"description": "Required. The resource name of the project associated with the service\naccounts, such as `projects/my-project-123`.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/projects/{projectsId}/serviceAccounts"
},
"getIamPolicy": {
"description": "Returns the IAM access control policy for a\nServiceAccount.",
"response": {
"$ref": "Policy"
},
"parameterOrder": [
"resource"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:getIamPolicy",
"id": "iam.projects.serviceAccounts.getIamPolicy",
"path": "v1/{+resource}:getIamPolicy"
},
"get": {
"path": "v1/{+name}",
"id": "iam.projects.serviceAccounts.get",
"description": "Gets a ServiceAccount.",
"httpMethod": "GET",
"response": {
"$ref": "ServiceAccount"
},
"parameterOrder": [
"name"
],
"parameters": {
"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.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}"
},
"update": {
"path": "v1/{+name}",
"id": "iam.projects.serviceAccounts.update",
"description": "Updates a ServiceAccount.\n\nCurrently, only the following fields are updatable:\n`display_name` .\nThe `etag` is mandatory.",
"request": {
"$ref": "ServiceAccount"
},
"httpMethod": "PUT",
"parameterOrder": [
"name"
],
"response": {
"$ref": "ServiceAccount"
},
"parameters": {
"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",
"required": true,
"pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}"
},
"testIamPermissions": {
"request": {
"$ref": "TestIamPermissionsRequest"
},
"description": "Tests the specified permissions against the IAM access control policy\nfor a ServiceAccount.",
"response": {
"$ref": "TestIamPermissionsResponse"
},
"parameterOrder": [
"resource"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:testIamPermissions",
"id": "iam.projects.serviceAccounts.testIamPermissions",
"path": "v1/{+resource}:testIamPermissions"
}
},
"resources": {
"keys": {
"methods": {
"delete": {
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
"httpMethod": "DELETE",
"parameters": {
"name": {
"pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$",
"location": "path",
"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.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}",
"id": "iam.projects.serviceAccounts.keys.delete",
"path": "v1/{+name}",
"description": "Deletes a ServiceAccountKey."
},
"get": {
"description": "Gets the ServiceAccountKey\nby key id.",
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"response": {
"$ref": "ServiceAccountKey"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"publicKeyType": {
"location": "query",
"enum": [
"TYPE_NONE",
"TYPE_X509_PEM_FILE",
"TYPE_RAW_PUBLIC_KEY"
],
"description": "The output format of the public key requested.\nX509_PEM is the default output format.",
"type": "string"
},
"name": {
"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.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}",
"id": "iam.projects.serviceAccounts.keys.get",
"path": "v1/{+name}"
},
"list": {
"response": {
"$ref": "ListServiceAccountKeysResponse"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"parameters": {
"keyTypes": {
"enum": [
"KEY_TYPE_UNSPECIFIED",
"USER_MANAGED",
"SYSTEM_MANAGED"
],
"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.",
"type": "string",
"repeated": true,
"location": "query"
},
"name": {
"pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
"location": "path",
"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.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys",
"id": "iam.projects.serviceAccounts.keys.list",
"path": "v1/{+name}/keys",
"description": "Lists ServiceAccountKeys."
},
"create": {
"response": {
"$ref": "ServiceAccountKey"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"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.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys",
"id": "iam.projects.serviceAccounts.keys.create",
"path": "v1/{+name}/keys",
"request": {
"$ref": "CreateServiceAccountKeyRequest"
},
"description": "Creates a ServiceAccountKey\nand returns it."
}
}
}
}
}
}
},
"permissions": {
"methods": {
"queryTestablePermissions": {
"response": {
"$ref": "QueryTestablePermissionsResponse"
},
"parameterOrder": [],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {},
"flatPath": "v1/permissions:queryTestablePermissions",
"id": "iam.permissions.queryTestablePermissions",
"path": "v1/permissions:queryTestablePermissions",
"request": {
"$ref": "QueryTestablePermissionsRequest"
},
"description": "Lists the permissions testable on a resource.\nA permission is testable if it can be tested for an identity on a resource."
}
}
},
"roles": {
"methods": {
"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.",
"request": {
"$ref": "QueryGrantableRolesRequest"
},
"response": {
"$ref": "QueryGrantableRolesResponse"
},
"parameterOrder": [],
"httpMethod": "POST",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/roles:queryGrantableRoles",
"id": "iam.roles.queryGrantableRoles",
"path": "v1/roles:queryGrantableRoles"
},
"get": {
"httpMethod": "GET",
"response": {
"$ref": "Role"
},
"parameterOrder": [
"name"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"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}`",
"type": "string",
"required": true,
"pattern": "^roles/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/roles/{rolesId}",
"path": "v1/{+name}",
"id": "iam.roles.get",
"description": "Gets a Role definition."
},
"list": {
"httpMethod": "GET",
"response": {
"$ref": "ListRolesResponse"
},
"parameterOrder": [],
"parameters": {
"pageToken": {
"location": "query",
"description": "Optional pagination token returned in an earlier ListRolesResponse.",
"type": "string"
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "Optional limit on the number of roles to include in the response.",
"type": "integer"
},
"view": {
"location": "query",
"enum": [
"BASIC",
"FULL"
],
"description": "Optional view for the returned Role objects.",
"type": "string"
},
"parent": {
"location": "query",
"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}`",
"type": "string"
},
"showDeleted": {
"location": "query",
"description": "Include Roles that have been deleted.",
"type": "boolean"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/roles",
"path": "v1/roles",
"id": "iam.roles.list",
"description": "Lists the Roles defined on a resource."
}
}
},
"organizations": {
"resources": {
"roles": {
"methods": {
"delete": {
"path": "v1/{+name}",
"id": "iam.organizations.roles.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.",
"httpMethod": "DELETE",
"response": {
"$ref": "Role"
},
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"pattern": "^organizations/[^/]+/roles/[^/]+$",
"location": "path",
"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}`",
"type": "string",
"required": true
},
"etag": {
"location": "query",
"format": "byte",
"description": "Used to perform a consistent read-modify-write.",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}"
},
"list": {
"id": "iam.organizations.roles.list",
"path": "v1/{+parent}/roles",
"description": "Lists the Roles defined on a resource.",
"response": {
"$ref": "ListRolesResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"pageToken": {
"location": "query",
"description": "Optional pagination token returned in an earlier ListRolesResponse.",
"type": "string"
},
"pageSize": {
"format": "int32",
"description": "Optional limit on the number of roles to include in the response.",
"type": "integer",
"location": "query"
},
"view": {
"enum": [
"BASIC",
"FULL"
],
"description": "Optional view for the returned Role objects.",
"type": "string",
"location": "query"
},
"parent": {
"pattern": "^organizations/[^/]+$",
"location": "path",
"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}`",
"type": "string",
"required": true
},
"showDeleted": {
"description": "Include Roles that have been deleted.",
"type": "boolean",
"location": "query"
}
},
"flatPath": "v1/organizations/{organizationsId}/roles"
},
"create": {
"response": {
"$ref": "Role"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"parameters": {
"parent": {
"pattern": "^organizations/[^/]+$",
"location": "path",
"description": "The resource name of the parent resource in one of the following formats:\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/organizations/{organizationsId}/roles",
"id": "iam.organizations.roles.create",
"path": "v1/{+parent}/roles",
"description": "Creates a new Role.",
"request": {
"$ref": "CreateRoleRequest"
}
},
"patch": {
"request": {
"$ref": "Role"
},
"description": "Updates a Role definition.",
"response": {
"$ref": "Role"
},
"parameterOrder": [
"name"
],
"httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"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}`",
"type": "string",
"required": true,
"pattern": "^organizations/[^/]+/roles/[^/]+$",
"location": "path"
},
"updateMask": {
"location": "query",
"format": "google-fieldmask",
"description": "A mask describing which fields in the Role have changed.",
"type": "string"
}
},
"flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}",
"id": "iam.organizations.roles.patch",
"path": "v1/{+name}"
},
"undelete": {
"id": "iam.organizations.roles.undelete",
"path": "v1/{+name}:undelete",
"request": {
"$ref": "UndeleteRoleRequest"
},
"description": "Undelete a Role, bringing it back in its previous state.",
"response": {
"$ref": "Role"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"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}`",
"type": "string",
"required": true,
"pattern": "^organizations/[^/]+/roles/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}:undelete"
},
"get": {
"response": {
"$ref": "Role"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"parameters": {
"name": {
"pattern": "^organizations/[^/]+/roles/[^/]+$",
"location": "path",
"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}`",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}",
"id": "iam.organizations.roles.get",
"path": "v1/{+name}",
"description": "Gets a Role definition."
}
}
}
}
}
},
"parameters": {
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
"$.xgafv": {
"enum": [
"1",
"2"
],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query"
},
"callback": {
"description": "JSONP",
"type": "string",
"location": "query"
},
"alt": {
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"description": "Data format for response.",
"default": "json",
"enum": [
"json",
"media",
"proto"
],
"type": "string"
},
"access_token": {
"location": "query",
"description": "OAuth access token.",
"type": "string"
},
"key": {
"location": "query",
"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.",
"type": "string"
},
"quotaUser": {
"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.",
"type": "string",
"location": "query"
},
"pp": {
"description": "Pretty-print response.",
"default": "true",
"type": "boolean",
"location": "query"
},
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
},
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
"prettyPrint": {
"location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
"type": "boolean"
}
},
"version": "v1",
"baseUrl": "https://iam.googleapis.com/",
"kind": "discovery#restDescription",
"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.",
"servicePath": "",
"basePath": "",
"id": "iam:v1",
"documentationLink": "https://cloud.google.com/iam/",
"revision": "20171006"
}