Privileged Access Manager v1 API - Namespace Google.Cloud.PrivilegedAccessManager.V1 (1.0.0)

Classes

AccessControlEntry

AccessControlEntry is used to control who can do some operation.

ApprovalWorkflow

Different types of approval workflows that can be used to gate privileged access granting.

ApproveGrantRequest

Request message for ApproveGrant method.

CheckOnboardingStatusRequest

Request message for CheckOnboardingStatus method.

CheckOnboardingStatusResponse

Response message for CheckOnboardingStatus method.

CheckOnboardingStatusResponse.Types

Container for nested types declared in the CheckOnboardingStatusResponse message type.

CheckOnboardingStatusResponse.Types.Finding

Finding represents an issue which prevents PAM from functioning properly for this resource.

CheckOnboardingStatusResponse.Types.Finding.Types

Container for nested types declared in the Finding message type.

CheckOnboardingStatusResponse.Types.Finding.Types.IAMAccessDenied

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.

CreateEntitlementRequest

Message for creating an entitlement.

CreateGrantRequest

Message for creating a grant

DeleteEntitlementRequest

Message for deleting an entitlement.

DenyGrantRequest

Request message for DenyGrant method.

Entitlement

An entitlement defines the eligibility of a set of users to obtain predefined access for some time possibly after going through an approval workflow.

Entitlement.Types

Container for nested types declared in the Entitlement message type.

Entitlement.Types.AdditionalNotificationTargets

AdditionalNotificationTargets includes email addresses to be notified.

Entitlement.Types.RequesterJustificationConfig

Defines how a requester must provide a justification when requesting access.

Entitlement.Types.RequesterJustificationConfig.Types

Container for nested types declared in the RequesterJustificationConfig message type.

Entitlement.Types.RequesterJustificationConfig.Types.NotMandatory

The justification is not mandatory but can be provided in any of the supported formats.

Entitlement.Types.RequesterJustificationConfig.Types.Unstructured

The requester has to provide a justification in the form of a string.

EntitlementName

Resource name for the Entitlement resource.

FolderLocationName

Resource name for the FolderLocation resource.

GetEntitlementRequest

Message for getting an entitlement.

GetGrantRequest

Message for getting a grant.

Grant

A grant represents a request from a user for obtaining the access specified in an entitlement they are eligible for.

Grant.Types

Container for nested types declared in the Grant message type.

Grant.Types.AuditTrail

Audit trail for the access provided by this grant.

Grant.Types.Timeline

Timeline of a grant describing what happened to it and when.

Grant.Types.Timeline.Types

Container for nested types declared in the Timeline message type.

Grant.Types.Timeline.Types.Event

A single operation on the grant.

Grant.Types.Timeline.Types.Event.Types

Container for nested types declared in the Event message type.

Grant.Types.Timeline.Types.Event.Types.Activated

An event representing that the grant was successfully activated.

Grant.Types.Timeline.Types.Event.Types.ActivationFailed

An event representing that the grant activation failed.

Grant.Types.Timeline.Types.Event.Types.Approved

An event representing that the grant was approved.

Grant.Types.Timeline.Types.Event.Types.Denied

An event representing that the grant was denied.

Grant.Types.Timeline.Types.Event.Types.Ended

An event representing that the grant has ended.

Grant.Types.Timeline.Types.Event.Types.Expired

An event representing that the grant was expired.

Grant.Types.Timeline.Types.Event.Types.ExternallyModified

An event representing that the policy bindings made by this grant were modified externally.

Grant.Types.Timeline.Types.Event.Types.Requested

An event representing that a grant was requested.

Grant.Types.Timeline.Types.Event.Types.Revoked

An event representing that the grant was revoked.

Grant.Types.Timeline.Types.Event.Types.Scheduled

An event representing that the grant has been scheduled to be activated later.

GrantName

Resource name for the Grant resource.

Justification

Justification represents a justification for requesting access.

ListEntitlementsRequest

Message for requesting list of entitlements.

ListEntitlementsResponse

Message for response to listing entitlements.

ListGrantsRequest

Message for requesting list of grants.

ListGrantsResponse

Message for response to listing grants.

ManualApprovals

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.

ManualApprovals.Types

Container for nested types declared in the ManualApprovals message type.

ManualApprovals.Types.Step

Step represents a logical step in a manual approval workflow.

OperationMetadata

Represents the metadata of the long-running operation.

OrganizationLocationName

Resource name for the OrganizationLocation resource.

PrivilegedAccess

Privileged access that this service can be used to gate.

PrivilegedAccess.Types

Container for nested types declared in the PrivilegedAccess message type.

PrivilegedAccess.Types.GcpIamAccess

GcpIamAccess represents IAM based access control on a Google Cloud resource. Refer to https://cloud.google.com/iam/docs to understand more about IAM.

PrivilegedAccess.Types.GcpIamAccess.Types

Container for nested types declared in the GcpIamAccess message type.

PrivilegedAccess.Types.GcpIamAccess.Types.RoleBinding

IAM role bindings that are created after a successful grant.

PrivilegedAccessManager

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.

PrivilegedAccessManager.PrivilegedAccessManagerBase

Base class for server-side implementations of PrivilegedAccessManager

PrivilegedAccessManager.PrivilegedAccessManagerClient

Client for PrivilegedAccessManager

PrivilegedAccessManagerClient

PrivilegedAccessManager client wrapper, for convenient use.

PrivilegedAccessManagerClientBuilder

Builder class for PrivilegedAccessManagerClient to provide simple configuration of credentials, endpoint etc.

PrivilegedAccessManagerClientImpl

PrivilegedAccessManager client wrapper implementation, for convenient use.

PrivilegedAccessManagerSettings

Settings for PrivilegedAccessManagerClient instances.

RevokeGrantRequest

Request message for RevokeGrant method.

SearchEntitlementsRequest

Request message for SearchEntitlements method.

SearchEntitlementsRequest.Types

Container for nested types declared in the SearchEntitlementsRequest message type.

SearchEntitlementsResponse

Response message for SearchEntitlements method.

SearchGrantsRequest

Request message for SearchGrants method.

SearchGrantsRequest.Types

Container for nested types declared in the SearchGrantsRequest message type.

SearchGrantsResponse

Response message for SearchGrants method.

UpdateEntitlementRequest

Message for updating an entitlement.

Enums

ApprovalWorkflow.ApprovalWorkflowOneofCase

Enum of possible cases for the "approval_workflow" oneof.

CheckOnboardingStatusResponse.Types.Finding.FindingTypeOneofCase

Enum of possible cases for the "finding_type" oneof.

Entitlement.Types.RequesterJustificationConfig.JustificationTypeOneofCase

Enum of possible cases for the "justification_type" oneof.

Entitlement.Types.State

Different states an entitlement can be in.

EntitlementName.ResourceNameType

The possible contents of EntitlementName.

FolderLocationName.ResourceNameType

The possible contents of FolderLocationName.

Grant.Types.State

Different states a grant can be in.

Grant.Types.Timeline.Types.Event.EventOneofCase

Enum of possible cases for the "event" oneof.

GrantName.ResourceNameType

The possible contents of GrantName.

Justification.JustificationOneofCase

Enum of possible cases for the "justification" oneof.

OrganizationLocationName.ResourceNameType

The possible contents of OrganizationLocationName.

PrivilegedAccess.AccessTypeOneofCase

Enum of possible cases for the "access_type" oneof.

SearchEntitlementsRequest.Types.CallerAccessType

Different types of access a user can have on the entitlement resource.

SearchGrantsRequest.Types.CallerRelationshipType

Different types of relationships a user can have with a grant.