Package types (0.1.3)

API documentation for privilegedaccessmanager_v1.types package.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ApproveGrantRequest

Request message for ApproveGrant method.

CheckOnboardingStatusRequest

Request message for CheckOnboardingStatus method.

CheckOnboardingStatusResponse

Response message for CheckOnboardingStatus method.

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.

GetEntitlementRequest

Message for getting an entitlement.

GetGrantRequest

Message for getting a grant.

Grant

This is to ensure that the Grants and ProducerGrants proto are byte compatible. A grant represents a request from a user for obtaining the access specified in an entitlement they are eligible for.

Justification

Justification represents a justification for requesting access.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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.

OperationMetadata

Represents the metadata of the long-running operation.

PrivilegedAccess

Privileged access that this service can be used to gate.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

RevokeGrantRequest

Request message for RevokeGrant method.

SearchEntitlementsRequest

Request message for SearchEntitlements method.

SearchEntitlementsResponse

Response message for SearchEntitlements method.

SearchGrantsRequest

Request message for SearchGrants method.

SearchGrantsResponse

Response message for SearchGrants method.

UpdateEntitlementRequest

Message for updating an entitlement.