Interface PrivilegedAccessManagerGrpc.AsyncService
- All Known Implementing Classes:
PrivilegedAccessManagerGrpc.PrivilegedAccessManagerImplBase
- Enclosing class:
- PrivilegedAccessManagerGrpc
public static interface PrivilegedAccessManagerGrpc.AsyncService
This API allows customers to manage temporary, request based privileged
access to their resources.
It defines the following resource model:
* A collection of `Entitlement` resources. An entitlement allows configuring
(among other things):
* Some kind of privileged access that users can request.
* A set of users called _requesters_ who can request this access.
* A maximum duration for which the access can be requested.
* An optional approval workflow which must be satisfied before access is
granted.
* A collection of `Grant` resources. A grant is a request by a requester to
get the privileged access specified in an entitlement for some duration.
After the approval workflow as specified in the entitlement is satisfied,
the specified access is given to the requester. The access is automatically
taken back after the requested duration is over.
-
Method Summary
Modifier and TypeMethodDescriptiondefault voidapproveGrant(ApproveGrantRequest request, io.grpc.stub.StreamObserver<Grant> responseObserver) `ApproveGrant` is used to approve a grant.default voidcheckOnboardingStatus(CheckOnboardingStatusRequest request, io.grpc.stub.StreamObserver<CheckOnboardingStatusResponse> responseObserver) `CheckOnboardingStatus` reports the onboarding status for a project/folder/organization.default voidcreateEntitlement(CreateEntitlementRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver) Creates a new entitlement in a given project/folder/organization and location.default voidcreateGrant(CreateGrantRequest request, io.grpc.stub.StreamObserver<Grant> responseObserver) Creates a new grant in a given project/folder/organization and location.default voiddeleteEntitlement(DeleteEntitlementRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver) Deletes a single entitlement.default voiddenyGrant(DenyGrantRequest request, io.grpc.stub.StreamObserver<Grant> responseObserver) `DenyGrant` is used to deny a grant.default voidgetEntitlement(GetEntitlementRequest request, io.grpc.stub.StreamObserver<Entitlement> responseObserver) Gets details of a single entitlement.default voidgetGrant(GetGrantRequest request, io.grpc.stub.StreamObserver<Grant> responseObserver) Get details of a single grant.default voidlistEntitlements(ListEntitlementsRequest request, io.grpc.stub.StreamObserver<ListEntitlementsResponse> responseObserver) Lists entitlements in a given project/folder/organization and location.default voidlistGrants(ListGrantsRequest request, io.grpc.stub.StreamObserver<ListGrantsResponse> responseObserver) Lists grants for a given entitlement.default voidrevokeGrant(RevokeGrantRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver) `RevokeGrant` is used to immediately revoke access for a grant.default voidsearchEntitlements(SearchEntitlementsRequest request, io.grpc.stub.StreamObserver<SearchEntitlementsResponse> responseObserver) `SearchEntitlements` returns entitlements on which the caller has the specified access.default voidsearchGrants(SearchGrantsRequest request, io.grpc.stub.StreamObserver<SearchGrantsResponse> responseObserver) `SearchGrants` returns grants that are related to the calling user in the specified way.default voidupdateEntitlement(UpdateEntitlementRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver) Updates the entitlement specified in the request.
-
Method Details
-
checkOnboardingStatus
default void checkOnboardingStatus(CheckOnboardingStatusRequest request, io.grpc.stub.StreamObserver<CheckOnboardingStatusResponse> responseObserver) `CheckOnboardingStatus` reports the onboarding status for a project/folder/organization. Any findings reported by this API need to be fixed before PAM can be used on the resource.
-
listEntitlements
default void listEntitlements(ListEntitlementsRequest request, io.grpc.stub.StreamObserver<ListEntitlementsResponse> responseObserver) Lists entitlements in a given project/folder/organization and location.
-
searchEntitlements
default void searchEntitlements(SearchEntitlementsRequest request, io.grpc.stub.StreamObserver<SearchEntitlementsResponse> responseObserver) `SearchEntitlements` returns entitlements on which the caller has the specified access.
-
getEntitlement
default void getEntitlement(GetEntitlementRequest request, io.grpc.stub.StreamObserver<Entitlement> responseObserver) Gets details of a single entitlement.
-
createEntitlement
default void createEntitlement(CreateEntitlementRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver) Creates a new entitlement in a given project/folder/organization and location.
-
deleteEntitlement
default void deleteEntitlement(DeleteEntitlementRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver) Deletes a single entitlement. This method can only be called when there are no in-progress (`ACTIVE`/`ACTIVATING`/`REVOKING`) grants under the entitlement.
-
updateEntitlement
default void updateEntitlement(UpdateEntitlementRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver) 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. -
listGrants
default void listGrants(ListGrantsRequest request, io.grpc.stub.StreamObserver<ListGrantsResponse> responseObserver) Lists grants for a given entitlement.
-
searchGrants
default void searchGrants(SearchGrantsRequest request, io.grpc.stub.StreamObserver<SearchGrantsResponse> responseObserver) `SearchGrants` returns grants that are related to the calling user in the specified way.
-
getGrant
Get details of a single grant.
-
createGrant
default void createGrant(CreateGrantRequest request, io.grpc.stub.StreamObserver<Grant> responseObserver) Creates a new grant in a given project/folder/organization and location.
-
approveGrant
default void approveGrant(ApproveGrantRequest request, io.grpc.stub.StreamObserver<Grant> responseObserver) `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.
-
denyGrant
default void denyGrant(DenyGrantRequest request, io.grpc.stub.StreamObserver<Grant> responseObserver) `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.
-
revokeGrant
default void revokeGrant(RevokeGrantRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver) `RevokeGrant` is used to immediately revoke access for a grant. This method can be called when the grant is in a non-terminal state.
-