Privileged Access Manager API

Service: privilegedaccessmanager.googleapis.com

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://privilegedaccessmanager.googleapis.com

REST Resource: v1beta.folders.locations

Methods
checkOnboardingStatus GET /v1beta/{parent=folders/*/locations/*}:checkOnboardingStatus
CheckOnboardingStatus reports the onboarding status for a project/folder/organization.
get GET /v1beta/{name=folders/*/locations/*}
Gets information about a location.
list GET /v1beta/{name=folders/*}/locations
Lists information about the supported locations for this service.

REST Resource: v1beta.folders.locations.entitlements

Methods
create POST /v1beta/{parent=folders/*/locations/*}/entitlements
Creates a new entitlement in a given project/folder/organization and location.
delete DELETE /v1beta/{name=folders/*/locations/*/entitlements/*}
Deletes a single entitlement.
get GET /v1beta/{name=folders/*/locations/*/entitlements/*}
Gets details of a single entitlement.
list GET /v1beta/{parent=folders/*/locations/*}/entitlements
Lists entitlements in a given project/folder/organization and location.
patch PATCH /v1beta/{entitlement.name=folders/*/locations/*/entitlements/*}
Updates the entitlement specified in the request.
search GET /v1beta/{parent=folders/*/locations/*}/entitlements:search
SearchEntitlements returns entitlements on which the caller has the specified access.

REST Resource: v1beta.folders.locations.entitlements.grants

Methods
approve POST /v1beta/{name=folders/*/locations/*/entitlements/*/grants/*}:approve
ApproveGrant is used to approve a grant.
create POST /v1beta/{parent=folders/*/locations/*/entitlements/*}/grants
Creates a new grant in a given project/folder/organization and location.
deny POST /v1beta/{name=folders/*/locations/*/entitlements/*/grants/*}:deny
DenyGrant is used to deny a grant.
get GET /v1beta/{name=folders/*/locations/*/entitlements/*/grants/*}
Get details of a single grant.
list GET /v1beta/{parent=folders/*/locations/*/entitlements/*}/grants
Lists grants for a given entitlement.
revoke POST /v1beta/{name=folders/*/locations/*/entitlements/*/grants/*}:revoke
RevokeGrant is used to immediately revoke access for a grant.
search GET /v1beta/{parent=folders/*/locations/*/entitlements/*}/grants:search
SearchGrants returns grants that are related to the calling user in the specified way.

REST Resource: v1beta.folders.locations.operations

Methods
delete DELETE /v1beta/{name=folders/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1beta/{name=folders/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1beta/{name=folders/*/locations/*}/operations
Lists operations that match the specified filter in the request.

REST Resource: v1beta.organizations.locations

Methods
checkOnboardingStatus GET /v1beta/{parent=organizations/*/locations/*}:checkOnboardingStatus
CheckOnboardingStatus reports the onboarding status for a project/folder/organization.
get GET /v1beta/{name=organizations/*/locations/*}
Gets information about a location.
list GET /v1beta/{name=organizations/*}/locations
Lists information about the supported locations for this service.

REST Resource: v1beta.organizations.locations.entitlements

Methods
create POST /v1beta/{parent=organizations/*/locations/*}/entitlements
Creates a new entitlement in a given project/folder/organization and location.
delete DELETE /v1beta/{name=organizations/*/locations/*/entitlements/*}
Deletes a single entitlement.
get GET /v1beta/{name=organizations/*/locations/*/entitlements/*}
Gets details of a single entitlement.
list GET /v1beta/{parent=organizations/*/locations/*}/entitlements
Lists entitlements in a given project/folder/organization and location.
patch PATCH /v1beta/{entitlement.name=organizations/*/locations/*/entitlements/*}
Updates the entitlement specified in the request.
search GET /v1beta/{parent=organizations/*/locations/*}/entitlements:search
SearchEntitlements returns entitlements on which the caller has the specified access.

REST Resource: v1beta.organizations.locations.entitlements.grants

Methods
approve POST /v1beta/{name=organizations/*/locations/*/entitlements/*/grants/*}:approve
ApproveGrant is used to approve a grant.
create POST /v1beta/{parent=organizations/*/locations/*/entitlements/*}/grants
Creates a new grant in a given project/folder/organization and location.
deny POST /v1beta/{name=organizations/*/locations/*/entitlements/*/grants/*}:deny
DenyGrant is used to deny a grant.
get GET /v1beta/{name=organizations/*/locations/*/entitlements/*/grants/*}
Get details of a single grant.
list GET /v1beta/{parent=organizations/*/locations/*/entitlements/*}/grants
Lists grants for a given entitlement.
revoke POST /v1beta/{name=organizations/*/locations/*/entitlements/*/grants/*}:revoke
RevokeGrant is used to immediately revoke access for a grant.
search GET /v1beta/{parent=organizations/*/locations/*/entitlements/*}/grants:search
SearchGrants returns grants that are related to the calling user in the specified way.

REST Resource: v1beta.organizations.locations.operations

Methods
delete DELETE /v1beta/{name=organizations/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1beta/{name=organizations/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1beta/{name=organizations/*/locations/*}/operations
Lists operations that match the specified filter in the request.

REST Resource: v1beta.projects.locations

Methods
checkOnboardingStatus GET /v1beta/{parent=projects/*/locations/*}:checkOnboardingStatus
CheckOnboardingStatus reports the onboarding status for a project/folder/organization.
get GET /v1beta/{name=projects/*/locations/*}
Gets information about a location.
list GET /v1beta/{name=projects/*}/locations
Lists information about the supported locations for this service.

REST Resource: v1beta.projects.locations.entitlements

Methods
create POST /v1beta/{parent=projects/*/locations/*}/entitlements
Creates a new entitlement in a given project/folder/organization and location.
delete DELETE /v1beta/{name=projects/*/locations/*/entitlements/*}
Deletes a single entitlement.
get GET /v1beta/{name=projects/*/locations/*/entitlements/*}
Gets details of a single entitlement.
list GET /v1beta/{parent=projects/*/locations/*}/entitlements
Lists entitlements in a given project/folder/organization and location.
patch PATCH /v1beta/{entitlement.name=projects/*/locations/*/entitlements/*}
Updates the entitlement specified in the request.
search GET /v1beta/{parent=projects/*/locations/*}/entitlements:search
SearchEntitlements returns entitlements on which the caller has the specified access.

REST Resource: v1beta.projects.locations.entitlements.grants

Methods
approve POST /v1beta/{name=projects/*/locations/*/entitlements/*/grants/*}:approve
ApproveGrant is used to approve a grant.
create POST /v1beta/{parent=projects/*/locations/*/entitlements/*}/grants
Creates a new grant in a given project/folder/organization and location.
deny POST /v1beta/{name=projects/*/locations/*/entitlements/*/grants/*}:deny
DenyGrant is used to deny a grant.
get GET /v1beta/{name=projects/*/locations/*/entitlements/*/grants/*}
Get details of a single grant.
list GET /v1beta/{parent=projects/*/locations/*/entitlements/*}/grants
Lists grants for a given entitlement.
revoke POST /v1beta/{name=projects/*/locations/*/entitlements/*/grants/*}:revoke
RevokeGrant is used to immediately revoke access for a grant.
search GET /v1beta/{parent=projects/*/locations/*/entitlements/*}/grants:search
SearchGrants returns grants that are related to the calling user in the specified way.

REST Resource: v1beta.projects.locations.operations

Methods
delete DELETE /v1beta/{name=projects/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1beta/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1beta/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request.

REST Resource: v1.folders.locations

Methods
checkOnboardingStatus GET /v1/{parent=folders/*/locations/*}:checkOnboardingStatus
CheckOnboardingStatus reports the onboarding status for a project/folder/organization.
get GET /v1/{name=folders/*/locations/*}
Gets information about a location.
list GET /v1/{name=folders/*}/locations
Lists information about the supported locations for this service.

REST Resource: v1.folders.locations.entitlements

Methods
create POST /v1/{parent=folders/*/locations/*}/entitlements
Creates a new entitlement in a given project/folder/organization and location.
delete DELETE /v1/{name=folders/*/locations/*/entitlements/*}
Deletes a single entitlement.
get GET /v1/{name=folders/*/locations/*/entitlements/*}
Gets details of a single entitlement.
list GET /v1/{parent=folders/*/locations/*}/entitlements
Lists entitlements in a given project/folder/organization and location.
patch PATCH /v1/{entitlement.name=folders/*/locations/*/entitlements/*}
Updates the entitlement specified in the request.
search GET /v1/{parent=folders/*/locations/*}/entitlements:search
SearchEntitlements returns entitlements on which the caller has the specified access.

REST Resource: v1.folders.locations.entitlements.grants

Methods
approve POST /v1/{name=folders/*/locations/*/entitlements/*/grants/*}:approve
ApproveGrant is used to approve a grant.
create POST /v1/{parent=folders/*/locations/*/entitlements/*}/grants
Creates a new grant in a given project/folder/organization and location.
deny POST /v1/{name=folders/*/locations/*/entitlements/*/grants/*}:deny
DenyGrant is used to deny a grant.
get GET /v1/{name=folders/*/locations/*/entitlements/*/grants/*}
Get details of a single grant.
list GET /v1/{parent=folders/*/locations/*/entitlements/*}/grants
Lists grants for a given entitlement.
revoke POST /v1/{name=folders/*/locations/*/entitlements/*/grants/*}:revoke
RevokeGrant is used to immediately revoke access for a grant.
search GET /v1/{parent=folders/*/locations/*/entitlements/*}/grants:search
SearchGrants returns grants that are related to the calling user in the specified way.

REST Resource: v1.folders.locations.operations

Methods
delete DELETE /v1/{name=folders/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1/{name=folders/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1/{name=folders/*/locations/*}/operations
Lists operations that match the specified filter in the request.

REST Resource: v1.organizations.locations

Methods
checkOnboardingStatus GET /v1/{parent=organizations/*/locations/*}:checkOnboardingStatus
CheckOnboardingStatus reports the onboarding status for a project/folder/organization.
get GET /v1/{name=organizations/*/locations/*}
Gets information about a location.
list GET /v1/{name=organizations/*}/locations
Lists information about the supported locations for this service.

REST Resource: v1.organizations.locations.entitlements

Methods
create POST /v1/{parent=organizations/*/locations/*}/entitlements
Creates a new entitlement in a given project/folder/organization and location.
delete DELETE /v1/{name=organizations/*/locations/*/entitlements/*}
Deletes a single entitlement.
get GET /v1/{name=organizations/*/locations/*/entitlements/*}
Gets details of a single entitlement.
list GET /v1/{parent=organizations/*/locations/*}/entitlements
Lists entitlements in a given project/folder/organization and location.
patch PATCH /v1/{entitlement.name=organizations/*/locations/*/entitlements/*}
Updates the entitlement specified in the request.
search GET /v1/{parent=organizations/*/locations/*}/entitlements:search
SearchEntitlements returns entitlements on which the caller has the specified access.

REST Resource: v1.organizations.locations.entitlements.grants

Methods
approve POST /v1/{name=organizations/*/locations/*/entitlements/*/grants/*}:approve
ApproveGrant is used to approve a grant.
create POST /v1/{parent=organizations/*/locations/*/entitlements/*}/grants
Creates a new grant in a given project/folder/organization and location.
deny POST /v1/{name=organizations/*/locations/*/entitlements/*/grants/*}:deny
DenyGrant is used to deny a grant.
get GET /v1/{name=organizations/*/locations/*/entitlements/*/grants/*}
Get details of a single grant.
list GET /v1/{parent=organizations/*/locations/*/entitlements/*}/grants
Lists grants for a given entitlement.
revoke POST /v1/{name=organizations/*/locations/*/entitlements/*/grants/*}:revoke
RevokeGrant is used to immediately revoke access for a grant.
search GET /v1/{parent=organizations/*/locations/*/entitlements/*}/grants:search
SearchGrants returns grants that are related to the calling user in the specified way.

REST Resource: v1.organizations.locations.operations

Methods
delete DELETE /v1/{name=organizations/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1/{name=organizations/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1/{name=organizations/*/locations/*}/operations
Lists operations that match the specified filter in the request.

REST Resource: v1.projects.locations

Methods
checkOnboardingStatus GET /v1/{parent=projects/*/locations/*}:checkOnboardingStatus
CheckOnboardingStatus reports the onboarding status for a project/folder/organization.
get GET /v1/{name=projects/*/locations/*}
Gets information about a location.
list GET /v1/{name=projects/*}/locations
Lists information about the supported locations for this service.

REST Resource: v1.projects.locations.entitlements

Methods
create POST /v1/{parent=projects/*/locations/*}/entitlements
Creates a new entitlement in a given project/folder/organization and location.
delete DELETE /v1/{name=projects/*/locations/*/entitlements/*}
Deletes a single entitlement.
get GET /v1/{name=projects/*/locations/*/entitlements/*}
Gets details of a single entitlement.
list GET /v1/{parent=projects/*/locations/*}/entitlements
Lists entitlements in a given project/folder/organization and location.
patch PATCH /v1/{entitlement.name=projects/*/locations/*/entitlements/*}
Updates the entitlement specified in the request.
search GET /v1/{parent=projects/*/locations/*}/entitlements:search
SearchEntitlements returns entitlements on which the caller has the specified access.

REST Resource: v1.projects.locations.entitlements.grants

Methods
approve POST /v1/{name=projects/*/locations/*/entitlements/*/grants/*}:approve
ApproveGrant is used to approve a grant.
create POST /v1/{parent=projects/*/locations/*/entitlements/*}/grants
Creates a new grant in a given project/folder/organization and location.
deny POST /v1/{name=projects/*/locations/*/entitlements/*/grants/*}:deny
DenyGrant is used to deny a grant.
get GET /v1/{name=projects/*/locations/*/entitlements/*/grants/*}
Get details of a single grant.
list GET /v1/{parent=projects/*/locations/*/entitlements/*}/grants
Lists grants for a given entitlement.
revoke POST /v1/{name=projects/*/locations/*/entitlements/*/grants/*}:revoke
RevokeGrant is used to immediately revoke access for a grant.
search GET /v1/{parent=projects/*/locations/*/entitlements/*}/grants:search
SearchGrants returns grants that are related to the calling user in the specified way.

REST Resource: v1.projects.locations.operations

Methods
delete DELETE /v1/{name=projects/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request.