Privileged Access Manager v1 API - Class PrivilegedAccessManager.PrivilegedAccessManagerBase (1.0.0)

Version latest

• 1.0.0 (latest)
• 1.0.0-beta01

[BindServiceMethod(typeof(PrivilegedAccessManager), "BindService")]
public abstract class PrivilegedAccessManager.PrivilegedAccessManagerBase

Reference documentation and code samples for the Privileged Access Manager v1 API class PrivilegedAccessManager.PrivilegedAccessManagerBase.

Base class for server-side implementations of PrivilegedAccessManager

Inheritance

object > PrivilegedAccessManager.PrivilegedAccessManagerBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.PrivilegedAccessManager.V1

Assembly

Google.Cloud.PrivilegedAccessManager.V1.dll

Methods

ApproveGrant(ApproveGrantRequest, ServerCallContext)

public virtual Task<Grant> ApproveGrant(ApproveGrantRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	ApproveGrantRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskGrant	The response to send back to the client (wrapped by a task).

CheckOnboardingStatus(CheckOnboardingStatusRequest, ServerCallContext)

public virtual Task<CheckOnboardingStatusResponse> CheckOnboardingStatus(CheckOnboardingStatusRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	CheckOnboardingStatusRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskCheckOnboardingStatusResponse	The response to send back to the client (wrapped by a task).

CreateEntitlement(CreateEntitlementRequest, ServerCallContext)

public virtual Task<Operation> CreateEntitlement(CreateEntitlementRequest request, ServerCallContext context)

Creates a new entitlement in a given project/folder/organization and location.

Parameters
Name	Description
request	CreateEntitlementRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateGrant(CreateGrantRequest, ServerCallContext)

public virtual Task<Grant> CreateGrant(CreateGrantRequest request, ServerCallContext context)

Creates a new grant in a given project/folder/organization and location.

Parameters
Name	Description
request	CreateGrantRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskGrant	The response to send back to the client (wrapped by a task).

DeleteEntitlement(DeleteEntitlementRequest, ServerCallContext)

public virtual Task<Operation> DeleteEntitlement(DeleteEntitlementRequest request, ServerCallContext context)

Deletes a single entitlement. This method can only be called when there are no in-progress (ACTIVE/ACTIVATING/REVOKING) grants under the entitlement.

Parameters
Name	Description
request	DeleteEntitlementRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DenyGrant(DenyGrantRequest, ServerCallContext)

public virtual Task<Grant> DenyGrant(DenyGrantRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	DenyGrantRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskGrant	The response to send back to the client (wrapped by a task).

GetEntitlement(GetEntitlementRequest, ServerCallContext)

public virtual Task<Entitlement> GetEntitlement(GetEntitlementRequest request, ServerCallContext context)

Gets details of a single entitlement.

Parameters
Name	Description
request	GetEntitlementRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEntitlement	The response to send back to the client (wrapped by a task).

GetGrant(GetGrantRequest, ServerCallContext)

public virtual Task<Grant> GetGrant(GetGrantRequest request, ServerCallContext context)

Get details of a single grant.

Parameters
Name	Description
request	GetGrantRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskGrant	The response to send back to the client (wrapped by a task).

ListEntitlements(ListEntitlementsRequest, ServerCallContext)

public virtual Task<ListEntitlementsResponse> ListEntitlements(ListEntitlementsRequest request, ServerCallContext context)

Lists entitlements in a given project/folder/organization and location.

Parameters
Name	Description
request	ListEntitlementsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListEntitlementsResponse	The response to send back to the client (wrapped by a task).

ListGrants(ListGrantsRequest, ServerCallContext)

public virtual Task<ListGrantsResponse> ListGrants(ListGrantsRequest request, ServerCallContext context)

Lists grants for a given entitlement.

Parameters
Name	Description
request	ListGrantsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListGrantsResponse	The response to send back to the client (wrapped by a task).

RevokeGrant(RevokeGrantRequest, ServerCallContext)

public virtual Task<Operation> RevokeGrant(RevokeGrantRequest request, ServerCallContext context)

RevokeGrant is used to immediately revoke access for a grant. This method can be called when the grant is in a non-terminal state.

Parameters
Name	Description
request	RevokeGrantRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

SearchEntitlements(SearchEntitlementsRequest, ServerCallContext)

public virtual Task<SearchEntitlementsResponse> SearchEntitlements(SearchEntitlementsRequest request, ServerCallContext context)

SearchEntitlements returns entitlements on which the caller has the specified access.

Parameters
Name	Description
request	SearchEntitlementsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskSearchEntitlementsResponse	The response to send back to the client (wrapped by a task).

SearchGrants(SearchGrantsRequest, ServerCallContext)

public virtual Task<SearchGrantsResponse> SearchGrants(SearchGrantsRequest request, ServerCallContext context)

SearchGrants returns grants that are related to the calling user in the specified way.

Parameters
Name	Description
request	SearchGrantsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskSearchGrantsResponse	The response to send back to the client (wrapped by a task).

UpdateEntitlement(UpdateEntitlementRequest, ServerCallContext)

public virtual Task<Operation> UpdateEntitlement(UpdateEntitlementRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	UpdateEntitlementRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).