{ "mtlsRootUrl": "https://privilegedaccessmanager.mtls.googleapis.com/", "ownerName": "Google", "title": "Privileged Access Manager API", "version_module": true, "protocol": "rest", "parameters": { "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "alt": { "type": "string", "description": "Data format for response.", "default": "json", "enum": [ "json", "media", "proto" ], "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" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "key": { "type": "string", "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.", "location": "query" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "quotaUser": { "type": "string", "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.", "location": "query" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query" } }, "canonicalName": "Privileged Access Manager", "documentationLink": "https://cloud.google.com/iam/docs/pam-overview", "servicePath": "", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "discoveryVersion": "v1", "description": "Privileged Access Manager (PAM) helps you to follow least privilege best practice to mitigate risks tied to privileged access misuse and abuse. You can shift from always-on standing privileges to on-demand access using time-bound and approval-based access elevations. IAM administrators specifically can use PAM to create entitlements that can grant temporary access to a specific resource scope. Requesters can explore eligible entitlements and request the access needed for their task, and approvers are notified when approvals require their attention. Streamlined workflows facilitated using PAM support several use cases, including the following: * Emergency access for incident responders * Time-boxed access for developers for critical deployment or maintenance * Temporary access for operators for data ingestion and audits * Temporary access to service accounts for automated tasks ", "id": "privilegedaccessmanager:v1", "batchPath": "batch", "fullyEncodeReservedExpansion": true, "kind": "discovery#restDescription", "name": "privilegedaccessmanager", "baseUrl": "https://privilegedaccessmanager.googleapis.com/", "basePath": "", "revision": "20260404", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "resources": { "projects": { "resources": { "locations": { "methods": { "checkOnboardingStatus": { "id": "privilegedaccessmanager.projects.locations.checkOnboardingStatus", "path": "v1/{+parent}:checkOnboardingStatus", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:checkOnboardingStatus", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The resource for which the onboarding status should be checked. Should be in one of the following formats: * `projects/{project-number|project-id}/locations/{region}` * `folders/{folder-number}/locations/{region}` * `organizations/{organization-number}/locations/{region}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "CheckOnboardingStatusResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "`CheckOnboardingStatus` reports the onboarding status for a project, folder, or organization. Any findings reported by this API need to be fixed before PAM can be used on the resource." }, "list": { "id": "privilegedaccessmanager.projects.locations.list", "path": "v1/{+name}/locations", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "parameters": { "name": { "description": "The resource that owns the locations collection, if applicable.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query", "type": "string" }, "extraLocationTypes": { "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListLocationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version." }, "get": { "id": "privilegedaccessmanager.projects.locations.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Resource name for the location.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Location" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets information about a location." } }, "resources": { "operations": { "methods": { "list": { "id": "privilegedaccessmanager.projects.locations.operations.list", "path": "v1/{+name}/operations", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "privilegedaccessmanager.projects.locations.operations.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "delete": { "id": "privilegedaccessmanager.projects.locations.operations.delete", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." } } }, "entitlements": { "methods": { "list": { "id": "privilegedaccessmanager.projects.locations.entitlements.list", "path": "v1/{+parent}/entitlements", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entitlements", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent which owns the entitlement resources.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, the server picks an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. Filtering results.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. Hint for how to order the results.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListEntitlementsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists the entitlements in a given project, folder, organization, and in a given location." }, "search": { "id": "privilegedaccessmanager.projects.locations.entitlements.search", "path": "v1/{+parent}/entitlements:search", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entitlements:search", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent which owns the entitlement resources.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "callerAccessType": { "description": "Required. Only entitlements where the calling user has this access are returned.", "location": "query", "type": "string", "enumDescriptions": [ "Unspecified access type.", "The user has access to create grants using this entitlement.", "The user has access to approve/deny grants created under this entitlement." ], "enum": [ "CALLER_ACCESS_TYPE_UNSPECIFIED", "GRANT_REQUESTER", "GRANT_APPROVER" ] }, "filter": { "description": "Optional. Only entitlements matching this filter are returned in the response.", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. Requested page size. The server may return fewer items than requested. If unspecified, the server picks an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "SearchEntitlementsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "`SearchEntitlements` returns entitlements on which the caller has the specified access." }, "get": { "id": "privilegedaccessmanager.projects.locations.entitlements.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entitlements/{entitlementsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Name of the resource.", "pattern": "^projects/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Entitlement" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single entitlement." }, "create": { "id": "privilegedaccessmanager.projects.locations.entitlements.create", "path": "v1/{+parent}/entitlements", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entitlements", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Name of the parent resource for the entitlement. Possible formats: * `organizations/{organization-number}/locations/{region}` * `folders/{folder-number}/locations/{region}` * `projects/{project-id|project-number}/locations/{region}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "entitlementId": { "description": "Required. The ID to use for this entitlement. This becomes the last part of the resource name. This value should be 4-63 characters in length, and valid characters are \"[a-z]\", \"[0-9]\", and \"-\". The first character should be from [a-z]. This value should be unique among all other entitlements under the specified `parent`.", "location": "query", "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees this for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request and returns the previous operation's response. This prevents clients from accidentally creating duplicate entitlements. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "Entitlement" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new entitlement in a given project, folder, organization, and in a given location." }, "delete": { "id": "privilegedaccessmanager.projects.locations.entitlements.delete", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entitlements/{entitlementsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. Name of the resource.", "pattern": "^projects/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees this for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "force": { "description": "Optional. If set to true, any child grant under this entitlement is also deleted. (Otherwise, the request only works if the entitlement has no child grant.)", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single entitlement. This method can only be called when there are no in-progress (`ACTIVE`/`ACTIVATING`/`REVOKING`) grants under the entitlement." }, "patch": { "id": "privilegedaccessmanager.projects.locations.entitlements.patch", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entitlements/{entitlementsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Identifier. Name of the entitlement. Possible formats: * `organizations/{organization-number}/locations/{region}/entitlements/{entitlement-id}` * `folders/{folder-number}/locations/{region}/entitlements/{entitlement-id}` * `projects/{project-id|project-number}/locations/{region}/entitlements/{entitlement-id}`", "pattern": "^projects/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Required. The list of fields to update. A field is overwritten if, and only if, it is in the mask. Any immutable fields set in the mask are ignored by the server. Repeated fields and map fields are only allowed in the last position of a `paths` string and overwrite the existing values. Hence an update to a repeated field or a map should contain the entire list of values. The fields specified in the update_mask are relative to the resource and not to the request. (e.g. `MaxRequestDuration`; *not* `entitlement.MaxRequestDuration`) A value of '*' for this field refers to full replacement of the resource.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "Entitlement" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the entitlement specified in the request. Updated fields in the entitlement need to be specified in an update mask. The changes made to an entitlement are applicable only on future grants of the entitlement. However, if new approvers are added or existing approvers are removed from the approval workflow, the changes are effective on existing grants. The following fields are not supported for updates: * All immutable fields * Entitlement name * Resource name * Resource type * Adding an approval workflow in an entitlement which previously had no approval workflow. * Deleting the approval workflow from an entitlement. * Adding or deleting a step in the approval workflow (only one step is supported) Note that updates are allowed on the list of approvers in an approval workflow step." } }, "resources": { "grants": { "methods": { "list": { "id": "privilegedaccessmanager.projects.locations.entitlements.grants.list", "path": "v1/{+parent}/grants", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent resource which owns the grants.", "pattern": "^projects/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Requested page size. The server may return fewer items than requested. If unspecified, the server picks an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. Filtering results.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. Hint for how to order the results", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListGrantsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists grants for a given entitlement." }, "search": { "id": "privilegedaccessmanager.projects.locations.entitlements.grants.search", "path": "v1/{+parent}/grants:search", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants:search", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent which owns the grant resources.", "pattern": "^projects/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "required": true, "type": "string" }, "callerRelationship": { "description": "Required. Only grants which the caller is related to by this relationship are returned in the response.", "location": "query", "type": "string", "enumDescriptions": [ "Unspecified caller relationship type.", "The user created this grant by calling `CreateGrant` earlier.", "The user is an approver for the entitlement that this grant is parented under and can currently approve/deny it.", "The caller had successfully approved/denied this grant earlier." ], "enum": [ "CALLER_RELATIONSHIP_TYPE_UNSPECIFIED", "HAD_CREATED", "CAN_APPROVE", "HAD_APPROVED" ] }, "filter": { "description": "Optional. Only grants matching this filter are returned in the response.", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. Requested page size. The server may return fewer items than requested. If unspecified, server picks an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "SearchGrantsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "`SearchGrants` returns grants that are related to the calling user in the specified way." }, "get": { "id": "privilegedaccessmanager.projects.locations.entitlements.grants.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Name of the resource.", "pattern": "^projects/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Grant" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get details of a single grant." }, "create": { "id": "privilegedaccessmanager.projects.locations.entitlements.grants.create", "path": "v1/{+parent}/grants", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Name of the parent entitlement for which this grant is being requested.", "pattern": "^projects/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees this for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate grants. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "Grant" }, "response": { "$ref": "Grant" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a grant in a given project, folder, or organization and location." }, "approve": { "id": "privilegedaccessmanager.projects.locations.entitlements.grants.approve", "path": "v1/{+name}:approve", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}:approve", "httpMethod": "POST", "parameters": { "name": { "description": "Required. Name of the grant resource which is being approved.", "pattern": "^projects/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "ApproveGrantRequest" }, "response": { "$ref": "Grant" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "`ApproveGrant` is used to approve a grant. This method can only be called on a grant when it's in the `APPROVAL_AWAITED` state. This operation can't be undone." }, "deny": { "id": "privilegedaccessmanager.projects.locations.entitlements.grants.deny", "path": "v1/{+name}:deny", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}:deny", "httpMethod": "POST", "parameters": { "name": { "description": "Required. Name of the grant resource which is being denied.", "pattern": "^projects/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "DenyGrantRequest" }, "response": { "$ref": "Grant" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "`DenyGrant` is used to deny a grant. This method can only be called on a grant when it's in the `APPROVAL_AWAITED` state. This operation can't be undone." }, "revoke": { "id": "privilegedaccessmanager.projects.locations.entitlements.grants.revoke", "path": "v1/{+name}:revoke", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}:revoke", "httpMethod": "POST", "parameters": { "name": { "description": "Required. Name of the grant resource which is being revoked.", "pattern": "^projects/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "RevokeGrantRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "`RevokeGrant` is used to immediately revoke access for a grant. This method can be called when the grant is in a non-terminal state." } } } } } } } } }, "organizations": { "resources": { "locations": { "methods": { "checkOnboardingStatus": { "id": "privilegedaccessmanager.organizations.locations.checkOnboardingStatus", "path": "v1/{+parent}:checkOnboardingStatus", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}:checkOnboardingStatus", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The resource for which the onboarding status should be checked. Should be in one of the following formats: * `projects/{project-number|project-id}/locations/{region}` * `folders/{folder-number}/locations/{region}` * `organizations/{organization-number}/locations/{region}`", "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "CheckOnboardingStatusResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "`CheckOnboardingStatus` reports the onboarding status for a project, folder, or organization. Any findings reported by this API need to be fixed before PAM can be used on the resource." }, "list": { "id": "privilegedaccessmanager.organizations.locations.list", "path": "v1/{+name}/locations", "flatPath": "v1/organizations/{organizationsId}/locations", "httpMethod": "GET", "parameters": { "name": { "description": "The resource that owns the locations collection, if applicable.", "pattern": "^organizations/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query", "type": "string" }, "extraLocationTypes": { "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListLocationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version." }, "get": { "id": "privilegedaccessmanager.organizations.locations.get", "path": "v1/{+name}", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Resource name for the location.", "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Location" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets information about a location." } }, "resources": { "operations": { "methods": { "list": { "id": "privilegedaccessmanager.organizations.locations.operations.list", "path": "v1/{+name}/operations", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "privilegedaccessmanager.organizations.locations.operations.get", "path": "v1/{+name}", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "delete": { "id": "privilegedaccessmanager.organizations.locations.operations.delete", "path": "v1/{+name}", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." } } }, "entitlements": { "methods": { "list": { "id": "privilegedaccessmanager.organizations.locations.entitlements.list", "path": "v1/{+parent}/entitlements", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/entitlements", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent which owns the entitlement resources.", "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, the server picks an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. Filtering results.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. Hint for how to order the results.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListEntitlementsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists the entitlements in a given project, folder, organization, and in a given location." }, "search": { "id": "privilegedaccessmanager.organizations.locations.entitlements.search", "path": "v1/{+parent}/entitlements:search", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/entitlements:search", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent which owns the entitlement resources.", "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "callerAccessType": { "description": "Required. Only entitlements where the calling user has this access are returned.", "location": "query", "type": "string", "enumDescriptions": [ "Unspecified access type.", "The user has access to create grants using this entitlement.", "The user has access to approve/deny grants created under this entitlement." ], "enum": [ "CALLER_ACCESS_TYPE_UNSPECIFIED", "GRANT_REQUESTER", "GRANT_APPROVER" ] }, "filter": { "description": "Optional. Only entitlements matching this filter are returned in the response.", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. Requested page size. The server may return fewer items than requested. If unspecified, the server picks an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "SearchEntitlementsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "`SearchEntitlements` returns entitlements on which the caller has the specified access." }, "get": { "id": "privilegedaccessmanager.organizations.locations.entitlements.get", "path": "v1/{+name}", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/entitlements/{entitlementsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Name of the resource.", "pattern": "^organizations/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Entitlement" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single entitlement." }, "create": { "id": "privilegedaccessmanager.organizations.locations.entitlements.create", "path": "v1/{+parent}/entitlements", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/entitlements", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Name of the parent resource for the entitlement. Possible formats: * `organizations/{organization-number}/locations/{region}` * `folders/{folder-number}/locations/{region}` * `projects/{project-id|project-number}/locations/{region}`", "pattern": "^organizations/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "entitlementId": { "description": "Required. The ID to use for this entitlement. This becomes the last part of the resource name. This value should be 4-63 characters in length, and valid characters are \"[a-z]\", \"[0-9]\", and \"-\". The first character should be from [a-z]. This value should be unique among all other entitlements under the specified `parent`.", "location": "query", "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees this for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request and returns the previous operation's response. This prevents clients from accidentally creating duplicate entitlements. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "Entitlement" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new entitlement in a given project, folder, organization, and in a given location." }, "delete": { "id": "privilegedaccessmanager.organizations.locations.entitlements.delete", "path": "v1/{+name}", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/entitlements/{entitlementsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. Name of the resource.", "pattern": "^organizations/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees this for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "force": { "description": "Optional. If set to true, any child grant under this entitlement is also deleted. (Otherwise, the request only works if the entitlement has no child grant.)", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single entitlement. This method can only be called when there are no in-progress (`ACTIVE`/`ACTIVATING`/`REVOKING`) grants under the entitlement." }, "patch": { "id": "privilegedaccessmanager.organizations.locations.entitlements.patch", "path": "v1/{+name}", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/entitlements/{entitlementsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Identifier. Name of the entitlement. Possible formats: * `organizations/{organization-number}/locations/{region}/entitlements/{entitlement-id}` * `folders/{folder-number}/locations/{region}/entitlements/{entitlement-id}` * `projects/{project-id|project-number}/locations/{region}/entitlements/{entitlement-id}`", "pattern": "^organizations/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Required. The list of fields to update. A field is overwritten if, and only if, it is in the mask. Any immutable fields set in the mask are ignored by the server. Repeated fields and map fields are only allowed in the last position of a `paths` string and overwrite the existing values. Hence an update to a repeated field or a map should contain the entire list of values. The fields specified in the update_mask are relative to the resource and not to the request. (e.g. `MaxRequestDuration`; *not* `entitlement.MaxRequestDuration`) A value of '*' for this field refers to full replacement of the resource.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "Entitlement" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the entitlement specified in the request. Updated fields in the entitlement need to be specified in an update mask. The changes made to an entitlement are applicable only on future grants of the entitlement. However, if new approvers are added or existing approvers are removed from the approval workflow, the changes are effective on existing grants. The following fields are not supported for updates: * All immutable fields * Entitlement name * Resource name * Resource type * Adding an approval workflow in an entitlement which previously had no approval workflow. * Deleting the approval workflow from an entitlement. * Adding or deleting a step in the approval workflow (only one step is supported) Note that updates are allowed on the list of approvers in an approval workflow step." } }, "resources": { "grants": { "methods": { "list": { "id": "privilegedaccessmanager.organizations.locations.entitlements.grants.list", "path": "v1/{+parent}/grants", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent resource which owns the grants.", "pattern": "^organizations/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Requested page size. The server may return fewer items than requested. If unspecified, the server picks an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. Filtering results.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. Hint for how to order the results", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListGrantsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists grants for a given entitlement." }, "search": { "id": "privilegedaccessmanager.organizations.locations.entitlements.grants.search", "path": "v1/{+parent}/grants:search", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants:search", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent which owns the grant resources.", "pattern": "^organizations/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "required": true, "type": "string" }, "callerRelationship": { "description": "Required. Only grants which the caller is related to by this relationship are returned in the response.", "location": "query", "type": "string", "enumDescriptions": [ "Unspecified caller relationship type.", "The user created this grant by calling `CreateGrant` earlier.", "The user is an approver for the entitlement that this grant is parented under and can currently approve/deny it.", "The caller had successfully approved/denied this grant earlier." ], "enum": [ "CALLER_RELATIONSHIP_TYPE_UNSPECIFIED", "HAD_CREATED", "CAN_APPROVE", "HAD_APPROVED" ] }, "filter": { "description": "Optional. Only grants matching this filter are returned in the response.", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. Requested page size. The server may return fewer items than requested. If unspecified, server picks an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "SearchGrantsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "`SearchGrants` returns grants that are related to the calling user in the specified way." }, "get": { "id": "privilegedaccessmanager.organizations.locations.entitlements.grants.get", "path": "v1/{+name}", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Name of the resource.", "pattern": "^organizations/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Grant" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get details of a single grant." }, "create": { "id": "privilegedaccessmanager.organizations.locations.entitlements.grants.create", "path": "v1/{+parent}/grants", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Name of the parent entitlement for which this grant is being requested.", "pattern": "^organizations/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees this for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate grants. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "Grant" }, "response": { "$ref": "Grant" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a grant in a given project, folder, or organization and location." }, "approve": { "id": "privilegedaccessmanager.organizations.locations.entitlements.grants.approve", "path": "v1/{+name}:approve", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}:approve", "httpMethod": "POST", "parameters": { "name": { "description": "Required. Name of the grant resource which is being approved.", "pattern": "^organizations/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "ApproveGrantRequest" }, "response": { "$ref": "Grant" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "`ApproveGrant` is used to approve a grant. This method can only be called on a grant when it's in the `APPROVAL_AWAITED` state. This operation can't be undone." }, "deny": { "id": "privilegedaccessmanager.organizations.locations.entitlements.grants.deny", "path": "v1/{+name}:deny", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}:deny", "httpMethod": "POST", "parameters": { "name": { "description": "Required. Name of the grant resource which is being denied.", "pattern": "^organizations/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "DenyGrantRequest" }, "response": { "$ref": "Grant" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "`DenyGrant` is used to deny a grant. This method can only be called on a grant when it's in the `APPROVAL_AWAITED` state. This operation can't be undone." }, "revoke": { "id": "privilegedaccessmanager.organizations.locations.entitlements.grants.revoke", "path": "v1/{+name}:revoke", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}:revoke", "httpMethod": "POST", "parameters": { "name": { "description": "Required. Name of the grant resource which is being revoked.", "pattern": "^organizations/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "RevokeGrantRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "`RevokeGrant` is used to immediately revoke access for a grant. This method can be called when the grant is in a non-terminal state." } } } } } } } } }, "folders": { "resources": { "locations": { "methods": { "checkOnboardingStatus": { "id": "privilegedaccessmanager.folders.locations.checkOnboardingStatus", "path": "v1/{+parent}:checkOnboardingStatus", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}:checkOnboardingStatus", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The resource for which the onboarding status should be checked. Should be in one of the following formats: * `projects/{project-number|project-id}/locations/{region}` * `folders/{folder-number}/locations/{region}` * `organizations/{organization-number}/locations/{region}`", "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "CheckOnboardingStatusResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "`CheckOnboardingStatus` reports the onboarding status for a project, folder, or organization. Any findings reported by this API need to be fixed before PAM can be used on the resource." }, "list": { "id": "privilegedaccessmanager.folders.locations.list", "path": "v1/{+name}/locations", "flatPath": "v1/folders/{foldersId}/locations", "httpMethod": "GET", "parameters": { "name": { "description": "The resource that owns the locations collection, if applicable.", "pattern": "^folders/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query", "type": "string" }, "extraLocationTypes": { "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListLocationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version." }, "get": { "id": "privilegedaccessmanager.folders.locations.get", "path": "v1/{+name}", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Resource name for the location.", "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Location" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets information about a location." } }, "resources": { "operations": { "methods": { "list": { "id": "privilegedaccessmanager.folders.locations.operations.list", "path": "v1/{+name}/operations", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "privilegedaccessmanager.folders.locations.operations.get", "path": "v1/{+name}", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^folders/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "delete": { "id": "privilegedaccessmanager.folders.locations.operations.delete", "path": "v1/{+name}", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "pattern": "^folders/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." } } }, "entitlements": { "methods": { "list": { "id": "privilegedaccessmanager.folders.locations.entitlements.list", "path": "v1/{+parent}/entitlements", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/entitlements", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent which owns the entitlement resources.", "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, the server picks an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. Filtering results.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. Hint for how to order the results.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListEntitlementsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists the entitlements in a given project, folder, organization, and in a given location." }, "search": { "id": "privilegedaccessmanager.folders.locations.entitlements.search", "path": "v1/{+parent}/entitlements:search", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/entitlements:search", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent which owns the entitlement resources.", "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "callerAccessType": { "description": "Required. Only entitlements where the calling user has this access are returned.", "location": "query", "type": "string", "enumDescriptions": [ "Unspecified access type.", "The user has access to create grants using this entitlement.", "The user has access to approve/deny grants created under this entitlement." ], "enum": [ "CALLER_ACCESS_TYPE_UNSPECIFIED", "GRANT_REQUESTER", "GRANT_APPROVER" ] }, "filter": { "description": "Optional. Only entitlements matching this filter are returned in the response.", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. Requested page size. The server may return fewer items than requested. If unspecified, the server picks an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "SearchEntitlementsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "`SearchEntitlements` returns entitlements on which the caller has the specified access." }, "get": { "id": "privilegedaccessmanager.folders.locations.entitlements.get", "path": "v1/{+name}", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/entitlements/{entitlementsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Name of the resource.", "pattern": "^folders/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Entitlement" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single entitlement." }, "create": { "id": "privilegedaccessmanager.folders.locations.entitlements.create", "path": "v1/{+parent}/entitlements", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/entitlements", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Name of the parent resource for the entitlement. Possible formats: * `organizations/{organization-number}/locations/{region}` * `folders/{folder-number}/locations/{region}` * `projects/{project-id|project-number}/locations/{region}`", "pattern": "^folders/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "entitlementId": { "description": "Required. The ID to use for this entitlement. This becomes the last part of the resource name. This value should be 4-63 characters in length, and valid characters are \"[a-z]\", \"[0-9]\", and \"-\". The first character should be from [a-z]. This value should be unique among all other entitlements under the specified `parent`.", "location": "query", "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees this for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request and returns the previous operation's response. This prevents clients from accidentally creating duplicate entitlements. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "Entitlement" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new entitlement in a given project, folder, organization, and in a given location." }, "delete": { "id": "privilegedaccessmanager.folders.locations.entitlements.delete", "path": "v1/{+name}", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/entitlements/{entitlementsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. Name of the resource.", "pattern": "^folders/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees this for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "force": { "description": "Optional. If set to true, any child grant under this entitlement is also deleted. (Otherwise, the request only works if the entitlement has no child grant.)", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single entitlement. This method can only be called when there are no in-progress (`ACTIVE`/`ACTIVATING`/`REVOKING`) grants under the entitlement." }, "patch": { "id": "privilegedaccessmanager.folders.locations.entitlements.patch", "path": "v1/{+name}", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/entitlements/{entitlementsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Identifier. Name of the entitlement. Possible formats: * `organizations/{organization-number}/locations/{region}/entitlements/{entitlement-id}` * `folders/{folder-number}/locations/{region}/entitlements/{entitlement-id}` * `projects/{project-id|project-number}/locations/{region}/entitlements/{entitlement-id}`", "pattern": "^folders/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Required. The list of fields to update. A field is overwritten if, and only if, it is in the mask. Any immutable fields set in the mask are ignored by the server. Repeated fields and map fields are only allowed in the last position of a `paths` string and overwrite the existing values. Hence an update to a repeated field or a map should contain the entire list of values. The fields specified in the update_mask are relative to the resource and not to the request. (e.g. `MaxRequestDuration`; *not* `entitlement.MaxRequestDuration`) A value of '*' for this field refers to full replacement of the resource.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "Entitlement" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the entitlement specified in the request. Updated fields in the entitlement need to be specified in an update mask. The changes made to an entitlement are applicable only on future grants of the entitlement. However, if new approvers are added or existing approvers are removed from the approval workflow, the changes are effective on existing grants. The following fields are not supported for updates: * All immutable fields * Entitlement name * Resource name * Resource type * Adding an approval workflow in an entitlement which previously had no approval workflow. * Deleting the approval workflow from an entitlement. * Adding or deleting a step in the approval workflow (only one step is supported) Note that updates are allowed on the list of approvers in an approval workflow step." } }, "resources": { "grants": { "methods": { "list": { "id": "privilegedaccessmanager.folders.locations.entitlements.grants.list", "path": "v1/{+parent}/grants", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/entitlements/{entitlementsId}/grants", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent resource which owns the grants.", "pattern": "^folders/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Requested page size. The server may return fewer items than requested. If unspecified, the server picks an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. Filtering results.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. Hint for how to order the results", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListGrantsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists grants for a given entitlement." }, "search": { "id": "privilegedaccessmanager.folders.locations.entitlements.grants.search", "path": "v1/{+parent}/grants:search", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/entitlements/{entitlementsId}/grants:search", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent which owns the grant resources.", "pattern": "^folders/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "required": true, "type": "string" }, "callerRelationship": { "description": "Required. Only grants which the caller is related to by this relationship are returned in the response.", "location": "query", "type": "string", "enumDescriptions": [ "Unspecified caller relationship type.", "The user created this grant by calling `CreateGrant` earlier.", "The user is an approver for the entitlement that this grant is parented under and can currently approve/deny it.", "The caller had successfully approved/denied this grant earlier." ], "enum": [ "CALLER_RELATIONSHIP_TYPE_UNSPECIFIED", "HAD_CREATED", "CAN_APPROVE", "HAD_APPROVED" ] }, "filter": { "description": "Optional. Only grants matching this filter are returned in the response.", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. Requested page size. The server may return fewer items than requested. If unspecified, server picks an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "SearchGrantsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "`SearchGrants` returns grants that are related to the calling user in the specified way." }, "get": { "id": "privilegedaccessmanager.folders.locations.entitlements.grants.get", "path": "v1/{+name}", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Name of the resource.", "pattern": "^folders/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Grant" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get details of a single grant." }, "create": { "id": "privilegedaccessmanager.folders.locations.entitlements.grants.create", "path": "v1/{+parent}/grants", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/entitlements/{entitlementsId}/grants", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Name of the parent entitlement for which this grant is being requested.", "pattern": "^folders/[^/]+/locations/[^/]+/entitlements/[^/]+$", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees this for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate grants. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "Grant" }, "response": { "$ref": "Grant" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a grant in a given project, folder, or organization and location." }, "approve": { "id": "privilegedaccessmanager.folders.locations.entitlements.grants.approve", "path": "v1/{+name}:approve", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}:approve", "httpMethod": "POST", "parameters": { "name": { "description": "Required. Name of the grant resource which is being approved.", "pattern": "^folders/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "ApproveGrantRequest" }, "response": { "$ref": "Grant" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "`ApproveGrant` is used to approve a grant. This method can only be called on a grant when it's in the `APPROVAL_AWAITED` state. This operation can't be undone." }, "deny": { "id": "privilegedaccessmanager.folders.locations.entitlements.grants.deny", "path": "v1/{+name}:deny", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}:deny", "httpMethod": "POST", "parameters": { "name": { "description": "Required. Name of the grant resource which is being denied.", "pattern": "^folders/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "DenyGrantRequest" }, "response": { "$ref": "Grant" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "`DenyGrant` is used to deny a grant. This method can only be called on a grant when it's in the `APPROVAL_AWAITED` state. This operation can't be undone." }, "revoke": { "id": "privilegedaccessmanager.folders.locations.entitlements.grants.revoke", "path": "v1/{+name}:revoke", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/entitlements/{entitlementsId}/grants/{grantsId}:revoke", "httpMethod": "POST", "parameters": { "name": { "description": "Required. Name of the grant resource which is being revoked.", "pattern": "^folders/[^/]+/locations/[^/]+/entitlements/[^/]+/grants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "RevokeGrantRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "`RevokeGrant` is used to immediately revoke access for a grant. This method can be called when the grant is in a non-terminal state." } } } } } } } } }, "operations": { "methods": { "cancel": { "id": "privilegedaccessmanager.operations.cancel", "path": "v1/{+name}:cancel", "flatPath": "v1/operations/{operationsId}:cancel", "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^operations/.*$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "CancelOperationRequest" }, "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." } } } }, "version": "v1", "schemas": { "ListOperationsResponse": { "id": "ListOperationsResponse", "description": "The response message for Operations.ListOperations.", "type": "object", "properties": { "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Operation" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "unreachable": { "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "type": "array", "items": { "type": "string" } } } }, "Operation": { "id": "Operation", "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "properties": { "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "metadata": { "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "response": { "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "Status": { "id": "Status", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "type": "object", "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" }, "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } } }, "GoogleProtobufEmpty": { "id": "GoogleProtobufEmpty", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "type": "object", "properties": {} }, "CancelOperationRequest": { "id": "CancelOperationRequest", "description": "The request message for Operations.CancelOperation.", "type": "object", "properties": {} }, "CheckOnboardingStatusResponse": { "id": "CheckOnboardingStatusResponse", "description": "Response message for `CheckOnboardingStatus` method.", "type": "object", "properties": { "serviceAccount": { "description": "The service account that PAM uses to act on this resource.", "type": "string" }, "findings": { "description": "List of issues that are preventing PAM from functioning for this resource and need to be fixed to complete onboarding. Some issues might not be detected or reported.", "type": "array", "items": { "$ref": "Finding" } } } }, "Finding": { "id": "Finding", "description": "Finding represents an issue which prevents PAM from functioning properly for this resource.", "type": "object", "properties": { "iamAccessDenied": { "description": "PAM's service account is being denied access by Cloud IAM.", "$ref": "IAMAccessDenied" } } }, "IAMAccessDenied": { "id": "IAMAccessDenied", "description": "PAM's service account is being denied access by Cloud IAM. This can be fixed by granting a role that contains the missing permissions to the service account or exempting it from deny policies if they are blocking the access.", "type": "object", "properties": { "missingPermissions": { "description": "List of permissions that are being denied.", "type": "array", "items": { "type": "string" } } } }, "ListEntitlementsResponse": { "id": "ListEntitlementsResponse", "description": "Message for response to listing entitlements.", "type": "object", "properties": { "entitlements": { "description": "The list of entitlements.", "type": "array", "items": { "$ref": "Entitlement" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "Entitlement": { "id": "Entitlement", "description": "An entitlement defines the eligibility of a set of users to obtain predefined access for some time possibly after going through an approval workflow.", "type": "object", "properties": { "name": { "description": "Identifier. Name of the entitlement. Possible formats: * `organizations/{organization-number}/locations/{region}/entitlements/{entitlement-id}` * `folders/{folder-number}/locations/{region}/entitlements/{entitlement-id}` * `projects/{project-id|project-number}/locations/{region}/entitlements/{entitlement-id}`", "type": "string" }, "createTime": { "description": "Output only. Create time stamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. Update time stamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "eligibleUsers": { "description": "Optional. Who can create grants using this entitlement. This list should contain at most one entry.", "type": "array", "items": { "$ref": "AccessControlEntry" } }, "approvalWorkflow": { "description": "Optional. The approvals needed before access are granted to a requester. No approvals are needed if this field is null.", "$ref": "ApprovalWorkflow" }, "privilegedAccess": { "description": "Optional. The access granted to a requester on successful approval.", "$ref": "PrivilegedAccess" }, "maxRequestDuration": { "description": "Required. The maximum amount of time that access is granted for a request. A requester can ask for a shorter duration but never a longer one. The supported range is between 30 minutes and 168 hours (7 days).", "type": "string", "format": "google-duration" }, "state": { "description": "Output only. Current state of this entitlement.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified state. This value is never returned by the server.", "The entitlement is being created.", "The entitlement is available for requesting access.", "The entitlement is being deleted.", "The entitlement has been deleted.", "The entitlement is being updated." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "AVAILABLE", "DELETING", "DELETED", "UPDATING" ] }, "requesterJustificationConfig": { "description": "Required. The manner in which the requester should provide a justification for requesting access.", "$ref": "RequesterJustificationConfig" }, "additionalNotificationTargets": { "description": "Optional. Additional email addresses to be notified based on actions taken.", "$ref": "AdditionalNotificationTargets" }, "etag": { "description": "An `etag` is used for optimistic concurrency control as a way to prevent simultaneous updates to the same entitlement. An `etag` is returned in the response to `GetEntitlement` and the caller should put the `etag` in the request to `UpdateEntitlement` so that their change is applied on the same version. If this field is omitted or if there is a mismatch while updating an entitlement, then the server rejects the request.", "type": "string" } } }, "AccessControlEntry": { "id": "AccessControlEntry", "description": "`AccessControlEntry` is used to control who can do some operation.", "type": "object", "properties": { "principals": { "description": "Optional. Users who are allowed for the operation. Each entry should be a valid v1 IAM principal identifier. The format for these is documented at: https://cloud.google.com/iam/docs/principal-identifiers#v1", "type": "array", "items": { "type": "string" } } } }, "ApprovalWorkflow": { "id": "ApprovalWorkflow", "description": "Different types of approval workflows that can be used to gate privileged access granting.", "type": "object", "properties": { "manualApprovals": { "description": "An approval workflow where users designated as approvers review and act on the grants.", "$ref": "ManualApprovals" } } }, "ManualApprovals": { "id": "ManualApprovals", "description": "A manual approval workflow where users who are designated as approvers need to call the `ApproveGrant`/`DenyGrant` APIs for a grant. The workflow can consist of multiple serial steps where each step defines who can act as approver in that step and how many of those users should approve before the workflow moves to the next step. This can be used to create approval workflows such as: * Require an approval from any user in a group G. * Require an approval from any k number of users from a Group G. * Require an approval from any user in a group G and then from a user U. A single user might be part of the `approvers` ACL for multiple steps in this workflow, but they can only approve once and that approval is only considered to satisfy the approval step at which it was granted.", "type": "object", "properties": { "requireApproverJustification": { "description": "Optional. Do the approvers need to provide a justification for their actions?", "type": "boolean" }, "steps": { "description": "Optional. List of approval steps in this workflow. These steps are followed in the specified order sequentially. Only 1 step is supported.", "type": "array", "items": { "$ref": "Step" } } } }, "Step": { "id": "Step", "description": "Step represents a logical step in a manual approval workflow.", "type": "object", "properties": { "approvers": { "description": "Optional. The potential set of approvers in this step. This list must contain at most one entry.", "type": "array", "items": { "$ref": "AccessControlEntry" } }, "approvalsNeeded": { "description": "Required. How many users from the above list need to approve. If there aren't enough distinct users in the list, then the workflow indefinitely blocks. Should always be greater than 0. 1 is the only supported value.", "type": "integer", "format": "int32" }, "approverEmailRecipients": { "description": "Optional. Additional email addresses to be notified when a grant is pending approval.", "type": "array", "items": { "type": "string" } } } }, "PrivilegedAccess": { "id": "PrivilegedAccess", "description": "Privileged access that this service can be used to gate.", "type": "object", "properties": { "gcpIamAccess": { "description": "Access to a Google Cloud resource through IAM.", "$ref": "GcpIamAccess" } } }, "GcpIamAccess": { "id": "GcpIamAccess", "description": "`GcpIamAccess` represents IAM based access control on a Google Cloud resource. Refer to https://cloud.google.com/iam/docs to understand more about IAM.", "type": "object", "properties": { "resourceType": { "description": "Required. The type of this resource.", "type": "string" }, "resource": { "description": "Required. Name of the resource.", "type": "string" }, "roleBindings": { "description": "Required. Role bindings that are created on successful grant.", "type": "array", "items": { "$ref": "RoleBinding" } } } }, "RoleBinding": { "id": "RoleBinding", "description": "IAM role bindings that are created after a successful grant.", "type": "object", "properties": { "role": { "description": "Required. IAM role to be granted. https://cloud.google.com/iam/docs/roles-overview.", "type": "string" }, "conditionExpression": { "description": "Optional. The expression field of the IAM condition to be associated with the role. If specified, a user with an active grant for this entitlement is able to access the resource only if this condition evaluates to true for their request. This field uses the same CEL format as IAM and supports all attributes that IAM supports, except tags. https://cloud.google.com/iam/docs/conditions-overview#attributes.", "type": "string" } } }, "RequesterJustificationConfig": { "id": "RequesterJustificationConfig", "description": "Defines how a requester must provide a justification when requesting access.", "type": "object", "properties": { "notMandatory": { "description": "This option means the requester isn't required to provide a justification.", "$ref": "NotMandatory" }, "unstructured": { "description": "This option means the requester must provide a string as justification. If this is selected, the server allows the requester to provide a justification but doesn't validate it.", "$ref": "Unstructured" } } }, "NotMandatory": { "id": "NotMandatory", "description": "The justification is not mandatory but can be provided in any of the supported formats.", "type": "object", "properties": {} }, "Unstructured": { "id": "Unstructured", "description": "The requester has to provide a justification in the form of a string.", "type": "object", "properties": {} }, "AdditionalNotificationTargets": { "id": "AdditionalNotificationTargets", "description": "`AdditionalNotificationTargets` includes email addresses to be notified.", "type": "object", "properties": { "adminEmailRecipients": { "description": "Optional. Additional email addresses to be notified when a principal (requester) is granted access.", "type": "array", "items": { "type": "string" } }, "requesterEmailRecipients": { "description": "Optional. Additional email address to be notified about an eligible entitlement.", "type": "array", "items": { "type": "string" } } } }, "SearchEntitlementsResponse": { "id": "SearchEntitlementsResponse", "description": "Response message for `SearchEntitlements` method.", "type": "object", "properties": { "entitlements": { "description": "The list of entitlements.", "type": "array", "items": { "$ref": "Entitlement" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } } }, "ListGrantsResponse": { "id": "ListGrantsResponse", "description": "Message for response to listing grants.", "type": "object", "properties": { "grants": { "description": "The list of grants.", "type": "array", "items": { "$ref": "Grant" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "Grant": { "id": "Grant", "description": "A grant represents a request from a user for obtaining the access specified in an entitlement they are eligible for.", "type": "object", "properties": { "name": { "description": "Identifier. Name of this grant. Possible formats: * `organizations/{organization-number}/locations/{region}/entitlements/{entitlement-id}/grants/{grant-id}` * `folders/{folder-number}/locations/{region}/entitlements/{entitlement-id}/grants/{grant-id}` * `projects/{project-id|project-number}/locations/{region}/entitlements/{entitlement-id}/grants/{grant-id}` The last segment of this name (`{grant-id}`) is autogenerated.", "type": "string" }, "createTime": { "description": "Output only. Create time stamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. Update time stamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "requester": { "description": "Output only. Username of the user who created this grant.", "readOnly": true, "type": "string" }, "requestedDuration": { "description": "Required. The amount of time access is needed for. This value should be shorter than the `max_request_duration` value of the entitlement.", "type": "string", "format": "google-duration" }, "justification": { "description": "Optional. Justification of why this access is needed.", "$ref": "Justification" }, "state": { "description": "Output only. Current state of this grant.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified state. This value is never returned by the server.", "The entitlement had an approval workflow configured and this grant is waiting for the workflow to complete.", "The approval workflow completed with a denied result. No access is granted for this grant. This is a terminal state.", "The approval workflow completed successfully with an approved result or none was configured. Access is provided at an appropriate time.", "Access is being given.", "Access was successfully given and is currently active.", "The system could not give access due to a non-retriable error. This is a terminal state.", "Expired after waiting for the approval workflow to complete. This is a terminal state.", "Access is being revoked.", "Access was revoked by a user. This is a terminal state.", "System took back access as the requested duration was over. This is a terminal state.", "Access is being withdrawn.", "Grant was withdrawn by the grant owner. This is a terminal state." ], "enum": [ "STATE_UNSPECIFIED", "APPROVAL_AWAITED", "DENIED", "SCHEDULED", "ACTIVATING", "ACTIVE", "ACTIVATION_FAILED", "EXPIRED", "REVOKING", "REVOKED", "ENDED", "WITHDRAWING", "WITHDRAWN" ] }, "timeline": { "description": "Output only. Timeline of this grant.", "readOnly": true, "$ref": "Timeline" }, "privilegedAccess": { "description": "Output only. The access that would be granted by this grant.", "readOnly": true, "$ref": "PrivilegedAccess" }, "auditTrail": { "description": "Output only. Audit trail of access provided by this grant. If unspecified then access was never granted.", "readOnly": true, "$ref": "AuditTrail" }, "additionalEmailRecipients": { "description": "Optional. Additional email addresses to notify for all the actions performed on the grant.", "type": "array", "items": { "type": "string" } }, "externallyModified": { "description": "Output only. Flag set by the PAM system to indicate that policy bindings made by this grant have been modified from outside PAM. After it is set, this flag remains set forever irrespective of the grant state. A `true` value here indicates that PAM no longer has any certainty on the access a user has because of this grant.", "readOnly": true, "type": "boolean" } } }, "Justification": { "id": "Justification", "description": "Justification represents a justification for requesting access.", "type": "object", "properties": { "unstructuredJustification": { "description": "A free form textual justification. The system only ensures that this is not empty. No other kind of validation is performed on the string.", "type": "string" } } }, "Timeline": { "id": "Timeline", "description": "Timeline of a grant describing what happened to it and when.", "type": "object", "properties": { "events": { "description": "Output only. The events that have occurred on this grant. This list contains entries in the same order as they occurred. The first entry is always be of type `Requested` and there is always at least one entry in this array.", "readOnly": true, "type": "array", "items": { "$ref": "Event" } } } }, "Event": { "id": "Event", "description": "A single operation on the grant.", "type": "object", "properties": { "requested": { "description": "The grant was requested.", "$ref": "Requested" }, "approved": { "description": "The grant was approved.", "$ref": "Approved" }, "denied": { "description": "The grant was denied.", "$ref": "Denied" }, "revoked": { "description": "The grant was revoked.", "$ref": "Revoked" }, "scheduled": { "description": "The grant has been scheduled to give access.", "$ref": "Scheduled" }, "activated": { "description": "The grant was successfully activated to give access.", "$ref": "Activated" }, "activationFailed": { "description": "There was a non-retriable error while trying to give access.", "$ref": "ActivationFailed" }, "expired": { "description": "The approval workflow did not complete in the necessary duration, and so the grant is expired.", "$ref": "Expired" }, "ended": { "description": "Access given by the grant ended automatically as the approved duration was over.", "$ref": "Ended" }, "externallyModified": { "description": "The policy bindings made by grant have been modified outside of PAM.", "$ref": "ExternallyModified" }, "withdrawn": { "description": "The grant was withdrawn.", "$ref": "Withdrawn" }, "eventTime": { "description": "Output only. The time (as recorded at server) when this event occurred.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "Requested": { "id": "Requested", "description": "An event representing that a grant was requested.", "type": "object", "properties": { "expireTime": { "description": "Output only. The time at which this grant expires unless the approval workflow completes. If omitted, then the request never expires.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "Approved": { "id": "Approved", "description": "An event representing that the grant was approved.", "type": "object", "properties": { "reason": { "description": "Output only. The reason provided by the approver for approving the grant.", "readOnly": true, "type": "string" }, "actor": { "description": "Output only. Username of the user who approved the grant.", "readOnly": true, "type": "string" } } }, "Denied": { "id": "Denied", "description": "An event representing that the grant was denied.", "type": "object", "properties": { "reason": { "description": "Output only. The reason provided by the approver for denying the grant.", "readOnly": true, "type": "string" }, "actor": { "description": "Output only. Username of the user who denied the grant.", "readOnly": true, "type": "string" } } }, "Revoked": { "id": "Revoked", "description": "An event representing that the grant was revoked.", "type": "object", "properties": { "reason": { "description": "Output only. The reason provided by the user for revoking the grant.", "readOnly": true, "type": "string" }, "actor": { "description": "Output only. Username of the user who revoked the grant.", "readOnly": true, "type": "string" } } }, "Scheduled": { "id": "Scheduled", "description": "An event representing that the grant has been scheduled to be activated later.", "type": "object", "properties": { "scheduledActivationTime": { "description": "Output only. The time at which the access is granted.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "Activated": { "id": "Activated", "description": "An event representing that the grant was successfully activated.", "type": "object", "properties": {} }, "ActivationFailed": { "id": "ActivationFailed", "description": "An event representing that the grant activation failed.", "type": "object", "properties": { "error": { "description": "Output only. The error that occurred while activating the grant.", "readOnly": true, "$ref": "Status" } } }, "Expired": { "id": "Expired", "description": "An event representing that the grant was expired.", "type": "object", "properties": {} }, "Ended": { "id": "Ended", "description": "An event representing that the grant has ended.", "type": "object", "properties": {} }, "ExternallyModified": { "id": "ExternallyModified", "description": "An event representing that the policy bindings made by this grant were modified externally.", "type": "object", "properties": {} }, "Withdrawn": { "id": "Withdrawn", "description": "An event representing that the grant was withdrawn.", "type": "object", "properties": {} }, "AuditTrail": { "id": "AuditTrail", "description": "Audit trail for the access provided by this grant.", "type": "object", "properties": { "accessGrantTime": { "description": "Output only. The time at which access was given.", "readOnly": true, "type": "string", "format": "google-datetime" }, "accessRemoveTime": { "description": "Output only. The time at which the system removed access. This could be because of an automatic expiry or because of a revocation. If unspecified, then access hasn't been removed yet.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "SearchGrantsResponse": { "id": "SearchGrantsResponse", "description": "Response message for `SearchGrants` method.", "type": "object", "properties": { "grants": { "description": "The list of grants.", "type": "array", "items": { "$ref": "Grant" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } } }, "ApproveGrantRequest": { "id": "ApproveGrantRequest", "description": "Request message for `ApproveGrant` method.", "type": "object", "properties": { "reason": { "description": "Optional. The reason for approving this grant. This is required if the `require_approver_justification` field of the `ManualApprovals` workflow used in this grant is true.", "type": "string" } } }, "DenyGrantRequest": { "id": "DenyGrantRequest", "description": "Request message for `DenyGrant` method.", "type": "object", "properties": { "reason": { "description": "Optional. The reason for denying this grant. This is required if `require_approver_justification` field of the `ManualApprovals` workflow used in this grant is true.", "type": "string" } } }, "RevokeGrantRequest": { "id": "RevokeGrantRequest", "description": "Request message for `RevokeGrant` method.", "type": "object", "properties": { "reason": { "description": "Optional. The reason for revoking this grant.", "type": "string" } } }, "ListLocationsResponse": { "id": "ListLocationsResponse", "description": "The response message for Locations.ListLocations.", "type": "object", "properties": { "locations": { "description": "A list of locations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Location" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } } }, "Location": { "id": "Location", "description": "A resource that represents a Google Cloud location.", "type": "object", "properties": { "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object", "additionalProperties": { "type": "string" } }, "metadata": { "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "OperationMetadata": { "id": "OperationMetadata", "description": "Represents the metadata of the long-running operation.", "type": "object", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "target": { "description": "Output only. Server-defined resource path for the target of the operation.", "readOnly": true, "type": "string" }, "verb": { "description": "Output only. Name of the verb executed by the operation.", "readOnly": true, "type": "string" }, "statusMessage": { "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true, "type": "string" }, "requestedCancellation": { "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "readOnly": true, "type": "boolean" }, "apiVersion": { "description": "Output only. API version used to start the operation.", "readOnly": true, "type": "string" } } } }, "rootUrl": "https://privilegedaccessmanager.googleapis.com/", "ownerDomain": "google.com" }