UNPKG

openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

1 lines 58.8 kB
{"openapi":"3.0.0","info":{"contact":{"name":"Google","url":"https://google.com"},"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.","title":"Identity and Access Management (IAM)","version":"v1","x-apiClientRegistration":{"url":"https://console.developers.google.com"},"x-apisguru-categories":["security"],"x-logo":{"url":"https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png"},"x-origin":[{"converter":{"url":"https://github.com/lucybot/api-spec-converter","version":"2.7.18"},"format":"google","url":"https://iam.googleapis.com/$discovery/rest?version=v1","version":"v1"}],"x-preferred":true,"x-providerName":"googleapis.com","x-serviceName":"iam"},"externalDocs":{"url":"https://cloud.google.com/iam/"},"tags":[{"name":"iamPolicies"},{"name":"organizations"},{"name":"permissions"},{"name":"projects"},{"name":"roles"}],"paths":{"/v1/iamPolicies:lintPolicy":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Lints a Cloud IAM policy object or its sub fields. Currently supports\ngoogle.iam.v1.Policy, google.iam.v1.Binding and\ngoogle.iam.v1.Binding.condition.\n\nEach lint operation consists of multiple lint validation units.\nValidation units have the following properties:\n\n- Each unit inspects the input object in regard to a particular\n linting aspect and issues a google.iam.admin.v1.LintResult\n disclosing the result.\n- Domain of discourse of each unit can be either\n google.iam.v1.Policy, google.iam.v1.Binding, or\n google.iam.v1.Binding.condition depending on the purpose of the\n validation.\n- A unit may require additional data (like the list of all possible\n enumerable values of a particular attribute used in the policy instance)\n which shall be provided by the caller. Refer to the comments of\n google.iam.admin.v1.LintPolicyRequest.context for more details.\n\nThe set of applicable validation units is determined by the Cloud IAM\nserver and is not configurable.\n\nRegardless of any lint issues or their severities, successful calls to\n`lintPolicy` return an HTTP 200 OK status code.","operationId":"iam.iamPolicies.lintPolicy","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LintPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/LintPolicyResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["iamPolicies"]}},"/v1/iamPolicies:queryAuditableServices":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Returns a list of services that support service level audit logging\nconfiguration for the given resource.","operationId":"iam.iamPolicies.queryAuditableServices","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAuditableServicesRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/QueryAuditableServicesResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["iamPolicies"]}},"/v1/permissions:queryTestablePermissions":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Lists the permissions testable on a resource.\nA permission is testable if it can be tested for an identity on a resource.","operationId":"iam.permissions.queryTestablePermissions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryTestablePermissionsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/QueryTestablePermissionsResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["permissions"]}},"/v1/roles":{"get":{"description":"Lists the Roles defined on a resource.","operationId":"iam.roles.list","parameters":[{"description":"Optional limit on the number of roles to include in the response.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Optional pagination token returned in an earlier ListRolesResponse.","in":"query","name":"pageToken","schema":{"type":"string"}},{"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}`","in":"query","name":"parent","schema":{"type":"string"}},{"description":"Include Roles that have been deleted.","in":"query","name":"showDeleted","schema":{"type":"boolean"}},{"description":"Optional view for the returned Role objects.","in":"query","name":"view","schema":{"type":"string","enum":["BASIC","FULL"]}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ListRolesResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["roles"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}]},"/v1/roles:queryGrantableRoles":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"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.","operationId":"iam.roles.queryGrantableRoles","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryGrantableRolesRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/QueryGrantableRolesResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["roles"]}},"/v1/{name}":{"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.","operationId":"iam.organizations.roles.delete","parameters":[{"description":"Used to perform a consistent read-modify-write.","in":"query","name":"etag","schema":{"type":"string"}},{"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}`","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Role"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["organizations"]},"get":{"description":"Gets a Role definition.","operationId":"iam.organizations.roles.get","parameters":[{"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}`","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}},{"description":"The output format of the public key requested.\nX509_PEM is the default output format.","in":"query","name":"publicKeyType","schema":{"type":"string","enum":["TYPE_NONE","TYPE_X509_PEM_FILE","TYPE_RAW_PUBLIC_KEY"]}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Role"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["organizations"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"patch":{"description":"Updates a Role definition.","operationId":"iam.organizations.roles.patch","parameters":[{"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}`","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}},{"description":"A mask describing which fields in the Role have changed.","in":"query","name":"updateMask","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Role"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Role"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["organizations"]},"put":{"description":"Updates a ServiceAccount.\n\nCurrently, only the following fields are updatable:\n`display_name` .\nThe `etag` is mandatory.","operationId":"iam.projects.serviceAccounts.update","parameters":[{"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}`.","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceAccount"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ServiceAccount"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{name}/keys":{"get":{"description":"Lists ServiceAccountKeys.","operationId":"iam.projects.serviceAccounts.keys.list","parameters":[{"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.","in":"query","name":"keyTypes","explode":true,"schema":{"type":"array","items":{"enum":["KEY_TYPE_UNSPECIFIED","USER_MANAGED","SYSTEM_MANAGED"],"type":"string"}}},{"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.","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ListServiceAccountKeysResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Creates a ServiceAccountKey\nand returns it.","operationId":"iam.projects.serviceAccounts.keys.create","parameters":[{"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.","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateServiceAccountKeyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ServiceAccountKey"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{name}/serviceAccounts":{"get":{"description":"Lists ServiceAccounts for a project.","operationId":"iam.projects.serviceAccounts.list","parameters":[{"description":"Required. The resource name of the project associated with the service\naccounts, such as `projects/my-project-123`.","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}},{"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.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Optional pagination token returned in an earlier\nListServiceAccountsResponse.next_page_token.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ListServiceAccountsResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Creates a ServiceAccount\nand returns it.","operationId":"iam.projects.serviceAccounts.create","parameters":[{"description":"Required. The resource name of the project associated with the service\naccounts, such as `projects/my-project-123`.","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateServiceAccountRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ServiceAccount"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{name}:signBlob":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"**Note**: This method is in the process of being deprecated. Call the\n[`signBlob()`](/iam/credentials/reference/rest/v1/projects.serviceAccounts/signBlob)\nmethod of the Cloud IAM Service Account Credentials API instead.\n\nSigns a blob using a service account's system-managed private key.","operationId":"iam.projects.serviceAccounts.signBlob","parameters":[{"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.","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignBlobRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SignBlobResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{name}:signJwt":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"**Note**: This method is in the process of being deprecated. Call the\n[`signJwt()`](/iam/credentials/reference/rest/v1/projects.serviceAccounts/signJwt)\nmethod of the Cloud IAM Service Account Credentials API instead.\n\nSigns 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.","operationId":"iam.projects.serviceAccounts.signJwt","parameters":[{"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.","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignJwtRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SignJwtResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{name}:undelete":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Undelete a Role, bringing it back in its previous state.","operationId":"iam.organizations.roles.undelete","parameters":[{"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}`","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UndeleteRoleRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Role"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["organizations"]}},"/v1/{parent}/roles":{"get":{"description":"Lists the Roles defined on a resource.","operationId":"iam.organizations.roles.list","parameters":[{"description":"Optional limit on the number of roles to include in the response.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Optional pagination token returned in an earlier ListRolesResponse.","in":"query","name":"pageToken","schema":{"type":"string"}},{"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}`","in":"path","name":"parent","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}},{"description":"Include Roles that have been deleted.","in":"query","name":"showDeleted","schema":{"type":"boolean"}},{"description":"Optional view for the returned Role objects.","in":"query","name":"view","schema":{"type":"string","enum":["BASIC","FULL"]}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ListRolesResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["organizations"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Creates a new Role.","operationId":"iam.organizations.roles.create","parameters":[{"description":"The resource name of the parent resource in one of the following formats:\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`","in":"path","name":"parent","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Role"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["organizations"]}},"/v1/{resource}:getIamPolicy":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Returns the IAM access control policy for a\nServiceAccount.","operationId":"iam.projects.serviceAccounts.getIamPolicy","parameters":[{"description":"REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.","in":"path","name":"resource","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Policy"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{resource}:setIamPolicy":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Sets the IAM access control policy for a\nServiceAccount.","operationId":"iam.projects.serviceAccounts.setIamPolicy","parameters":[{"description":"REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.","in":"path","name":"resource","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Policy"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{resource}:testIamPermissions":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Tests the specified permissions against the IAM access control policy\nfor a ServiceAccount.","operationId":"iam.projects.serviceAccounts.testIamPermissions","parameters":[{"description":"REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.","in":"path","name":"resource","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestIamPermissionsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TestIamPermissionsResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}}},"servers":[{"url":"https://iam.googleapis.com/"}],"components":{"parameters":{"access_token":{"description":"OAuth access token.","in":"query","name":"access_token","schema":{"type":"string"}},"alt":{"description":"Data format for response.","in":"query","name":"alt","schema":{"type":"string","enum":["json","media","proto"],"default":"json"}},"callback":{"description":"JSONP","in":"query","name":"callback","schema":{"type":"string"}},"fields":{"description":"Selector specifying which fields to include in a partial response.","in":"query","name":"fields","schema":{"type":"string"}},"key":{"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.","in":"query","name":"key","schema":{"type":"string"}},"oauth_token":{"description":"OAuth 2.0 token for the current user.","in":"query","name":"oauth_token","schema":{"type":"string"}},"prettyPrint":{"description":"Returns response with indentations and line breaks.","in":"query","name":"prettyPrint","schema":{"type":"boolean","default":true}},"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.","in":"query","name":"quotaUser","schema":{"type":"string"}},"uploadType":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","in":"query","name":"uploadType","schema":{"type":"string"}},"upload_protocol":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","in":"query","name":"upload_protocol","schema":{"type":"string"}},"_.xgafv":{"description":"V1 error format.","in":"query","name":"$.xgafv","schema":{"type":"string","enum":["1","2"]}}},"securitySchemes":{"Oauth2":{"description":"Oauth 2.0 authentication","type":"oauth2","flows":{"implicit":{"authorizationUrl":"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"}}}}},"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.","properties":{"auditLogConfigs":{"description":"The configuration for logging of each type of permission.","items":{"$ref":"#/components/schemas/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.","properties":{"policyDelta":{"$ref":"#/components/schemas/PolicyDelta"}},"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.","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"],"type":"string"}},"type":"object"},"AuditableService":{"description":"Contains information about an auditable service.","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`.","properties":{"condition":{"$ref":"#/components/schemas/Expr"},"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` .\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`.","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.","properties":{"action":{"description":"The action that was performed on a Binding.\nRequired","enum":["ACTION_UNSPECIFIED","ADD","REMOVE"],"type":"string"},"condition":{"$ref":"#/components/schemas/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"}},"type":"object"},"CreateRoleRequest":{"description":"The request to create a new role.","properties":{"role":{"$ref":"#/components/schemas/Role"},"roleId":{"description":"The role id to use for this role.","type":"string"}},"type":"object"},"CreateServiceAccountKeyRequest":{"description":"The service account key create request.","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"],"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"],"type":"string"}},"type":"object"},"CreateServiceAccountRequest":{"description":"The service account create request.","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":"#/components/schemas/ServiceAccount"}},"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 `{}`.","properties":{},"type":"object"},"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) > 0\"","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"}},"type":"object"},"LintPolicyRequest":{"description":"The request to lint a Cloud IAM policy object. LintPolicy is currently\nfunctional only for `lint_object` of type `condition`.","properties":{"binding":{"$ref":"#/components/schemas/Binding"},"condition":{"$ref":"#/components/schemas/Expr"},"context":{"additionalProperties":{"description":"Properties of the object."},"description":"`context` contains additional *permission-controlled* data that any\nlint unit may depend on, in form of `{key: value}` pairs. Currently, this\nfield is non-operational and it will not be used during the lint operation.","type":"object"},"fullResourceName":{"description":"The full resource name of the policy this lint request is about.\n\nThe name follows the Google Cloud Platform (GCP) resource format.\nFor example, a GCP project with ID `my-project` will be named\n`//cloudresourcemanager.googleapis.com/projects/my-project`.\n\nThe resource name is not used to read the policy instance from the Cloud\nIAM database. The candidate policy for lint has to be provided in the same\nrequest object.","type":"string"},"policy":{"$ref":"#/components/schemas/Policy"}},"type":"object"},"LintPolicyResponse":{"description":"The response of a lint operation. An empty response indicates\nthe operation was able to fully execute and no lint issue was found.","properties":{"lintResults":{"description":"List of lint results sorted by a composite <severity, binding_ordinal> key,\ndescending order of severity and ascending order of binding_ordinal.\nThere is no certain order among the same keys.\n\nFor cross-binding results (only if the input object to lint is\ninstance of google.iam.v1.Policy), there will be a\ngoogle.iam.admin.v1.LintResult for each of the involved bindings,\nand the associated debug_message may enumerate the other involved\nbinding ordinal number(s).","items":{"$ref":"#/components/schemas/LintResult"},"type":"array"}},"type":"object"},"LintResult":{"description":"Structured response of a single validation unit.","properties":{"bindingOrdinal":{"description":"0-based index ordinality of the binding in the input object associated\nwith this result.\nThis field is populated only if the input object to lint is of type\ngoogle.iam.v1.Policy, which can comprise more than one binding.\nIt is set to -1 if the result is not associated with any particular\nbinding and only targets the policy as a whole, such as results about\npolicy size violations.","format":"int32","type":"integer"},"debugMessage":{"description":"Human readable debug message associated with the issue.","type":"string"},"fieldName":{"description":"The name of the field for which this lint result is about.\n\nFor nested messages, `field_name` consists of names of the embedded fields\nseparated by period character. The top-level qualifier is the input object\nto lint in the request. For instance, if the lint request is on a\ngoogle.iam.v1.Policy and this lint result is about a condition\nexpression of one of the input policy bindings, the field would be\npopulated as `policy.bindings.condition.expression`.\n\nThis field does not identify the ordinality of the repetitive fields (for\ninstance bindings in a policy).","type":"string"},"level":{"description":"The validation unit level.","enum":["LEVEL_UNSPECIFIED","POLICY","BINDING","CONDITION"],"type":"string"},"locationOffset":{"description":"0-based character position of problematic construct within the object\nidentified by `field_name`. Currently, this is populated only for condition\nexpression.","format":"int32","type":"integer"},"severity":{"description":"The validation unit severity.","enum":["SEVERITY_UNSPECIFIED","ERROR","WARNING","NOTICE","INFO","DEPRECATED"],"type":"string"},"validationUnitName":{"description":"The validation unit name, for instance\n“lintValidationUnits/ConditionComplexityCheck”.","type":"string"}},"type":"object"},"ListRolesResponse":{"description":"The response containing the roles defined under a resource.","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":"#/components/schemas/Role"},"type":"array"}},"type":"object"},"ListServiceAccountKeysResponse":{"description":"The service account keys list response.","properties":{"keys":{"description":"The public keys for the service account.","items":{"$ref":"#/components/schemas/ServiceAccountKey"},"type":"array"}},"type":"object"},"ListServiceAccountsResponse":{"description":"The service account list response.","properties":{"accounts":{"description":"The list of matching service accounts.","items":{"$ref":"#/components/schemas/ServiceAccount"},"type":"array"},"nextPageToken":{"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.","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"],"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"],"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**JSON 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\n**YAML Example**\n\n bindings:\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 role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\n\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).","properties":{"auditConfigs":{"description":"Specifies cloud audit logging configuration for this policy.","items":{"$ref":"#/components/schemas/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":"#/components/schemas/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.","format":"byte","type":"string"},"version":{"description":"Deprecated.","format":"int32","type":"integer"}},"type":"object"},"PolicyDelta":{"description":"The difference delta between two policies.","properties":{"bindingDeltas":{"description":"The delta for Bindings between two policies.","items":{"$ref":"#/components/schemas/BindingDelta"},"type":"array"}},"type":"object"},"QueryAuditableServicesRequest":{"description":"A request to get the list of auditable services for a resource.","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.","properties":{"services":{"description":"The auditable services for a resource.","items":{"$ref":"#/components/schemas/AuditableService"},"type":"array"}},"type":"object"},"QueryGrantableRolesRequest":{"description":"The grantable role query request.","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.","type":"string"},"view":{"enum":["BASIC","FULL"],"type":"string"}},"type":"object"},"QueryGrantableRolesResponse":{"description":"The grantable role query response.","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":"#/components/schemas/Role"},"type":"array"}},"type":"object"},"QueryTestablePermissionsRequest":{"description":"A request to get permissions which can be tested on a resource.","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.","properties":{"nextPageT