Console
    Contact Us Start free

    Package google.cloud.privilegedaccessmanager.v1alpha

    Index

    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.

    ApproveGrant

    rpc ApproveGrant( ApproveGrantRequest ) returns ( Grant )

    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.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    CheckOnboardingStatus

    rpc CheckOnboardingStatus( CheckOnboardingStatusRequest ) returns ( CheckOnboardingStatusResponse )

    CheckOnboardingStatus reports the onboarding status for a project, folder, or organization. Any findings reported by this API need to be fixed before PAM can be used on the resource.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    IAM Permissions

    Requires the following IAM permission on the parent resource:

    • privilegedaccessmanager.locations.checkOnboardingStatus

    For more information, see the IAM documentation .

    CreateEntitlement

    rpc CreateEntitlement( CreateEntitlementRequest ) returns ( Operation )

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

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    IAM Permissions

    Requires the following IAM permission on the parent resource:

    • privilegedaccessmanager.entitlements.create

    For more information, see the IAM documentation .

    CreateGrant

    rpc CreateGrant( CreateGrantRequest ) returns ( Grant )

    Creates a grant in a given project, folder, or organization and location.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    DeleteEntitlement

    rpc DeleteEntitlement( DeleteEntitlementRequest ) returns ( Operation )

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

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    IAM Permissions

    Requires the following IAM permission on the name resource:

    • privilegedaccessmanager.entitlements.delete

    For more information, see the IAM documentation .

    DenyGrant

    rpc DenyGrant( DenyGrantRequest ) returns ( Grant )

    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.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    FetchEffectiveSettings

    rpc FetchEffectiveSettings( FetchEffectiveSettingsRequest ) returns ( FetchEffectiveSettingsResponse )

    FetchEffectiveSettings returns the effective PAM Settings for the given project, folder, or organization.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    IAM Permissions

    Requires the following IAM permission on the parent resource:

    • privilegedaccessmanager.settings.fetchEffective

    For more information, see the IAM documentation .

    GetEntitlement

    rpc GetEntitlement( GetEntitlementRequest ) returns ( Entitlement )

    Gets details of a single entitlement.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    IAM Permissions

    Requires the following IAM permission on the name resource:

    • privilegedaccessmanager.entitlements.get

    For more information, see the IAM documentation .

    GetGrant

    rpc GetGrant( GetGrantRequest ) returns ( Grant )

    Get details of a single grant.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    IAM Permissions

    Requires the following IAM permission on the name resource:

    • privilegedaccessmanager.grants.get

    For more information, see the IAM documentation .

    GetSettings

    rpc GetSettings( GetSettingsRequest ) returns ( Settings )

    GetSettings returns the PAM Settings for the given project, folder, or organization.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    IAM Permissions

    Requires the following IAM permission on the name resource:

    • privilegedaccessmanager.settings.get

    For more information, see the IAM documentation .

    ListEntitlements

    rpc ListEntitlements( ListEntitlementsRequest ) returns ( ListEntitlementsResponse )

    Lists the entitlements in a given project, folder, organization, and in a given location.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    IAM Permissions

    Requires the following IAM permission on the parent resource:

    • privilegedaccessmanager.entitlements.list

    For more information, see the IAM documentation .

    ListGrants

    rpc ListGrants( ListGrantsRequest ) returns ( ListGrantsResponse )

    Lists grants for a given entitlement.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    IAM Permissions

    Requires the following IAM permission on the parent resource:

    • privilegedaccessmanager.grants.list

    For more information, see the IAM documentation .

    RevokeGrant

    rpc RevokeGrant( RevokeGrantRequest ) returns ( Operation )

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

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    IAM Permissions

    Requires the following IAM permission on the name resource:

    • privilegedaccessmanager.grants.revoke

    For more information, see the IAM documentation .

    SearchEntitlements

    rpc SearchEntitlements( SearchEntitlementsRequest ) returns ( SearchEntitlementsResponse )

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

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    SearchGrants

    rpc SearchGrants( SearchGrantsRequest ) returns ( SearchGrantsResponse )

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

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    UpdateEntitlement

    rpc UpdateEntitlement( UpdateEntitlementRequest ) returns ( Operation )

    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.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    IAM Permissions

    Requires the following IAM permission on the name resource:

    • privilegedaccessmanager.entitlements.update

    For more information, see the IAM documentation .

    UpdateSettings

    rpc UpdateSettings( UpdateSettingsRequest ) returns ( Operation )

    UpdateSettings updates the PAM Settings resource specified in the request. Updated fields in the settings need to be specified in an update mask. The following fields are not supported for updates: * Settings name * Create time * Update time * Etag

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    IAM Permissions

    Requires the following IAM permission on the name resource:

    • privilegedaccessmanager.settings.update

    For more information, see the IAM documentation .

    WithdrawGrant

    rpc WithdrawGrant( WithdrawGrantRequest ) returns ( Operation )

    WithdrawGrant is used to immediately withdraw the grant. This method can be called when the grant is in a non-terminal state.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    AccessControlEntry

    AccessControlEntry is used to control who can do some operation.

    Fields
    principals[]

    string

    Optional. Users who are allowed for the operation. Each entry should be a valid v1 IAM principal identifier. The format for these is documented at: https://cloud.google.com/iam/docs/principal-identifiers#v1

    ApprovalWorkflow

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

    Fields

    Union field approval_workflow .

    approval_workflow can be only one of the following:

    manual_approvals

    ManualApprovals

    An approval workflow where users designated as approvers review and act on the grants.

    ApproveGrantRequest

    Request message for ApproveGrant method.

    Fields
    name

    string

    Required. Name of the grant resource which is being approved.
    reason

    string

    Optional. The reason for approving this grant. This is required if the require_approver_justification field of the ManualApprovals workflow used in this grant is true.

    CheckOnboardingStatusRequest

    Request message for CheckOnboardingStatus method.

    Fields
    parent

    string

    Required. The resource for which the onboarding status should be checked. Should be in one of the following formats:

    • projects/{project-number|project-id}/locations/{region}
    • folders/{folder-number}/locations/{region}
    • organizations/{organization-number}/locations/{region}

    CheckOnboardingStatusResponse

    Response message for CheckOnboardingStatus method.

    Fields
    findings[]

    Finding

    List of issues that are preventing PAM from functioning for this resource and need to be fixed to complete onboarding. Some issues might not be detected or reported.

    Finding

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

    Fields

    Union field finding_type .

    finding_type can be only one of the following:

    iam_access_denied

    IAMAccessDenied

    PAM's service account is being denied access by Cloud IAM.

    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.

    Fields
    missing_permissions[]

    string

    List of permissions that are being denied.

    CreateEntitlementRequest

    Message for creating an entitlement.

    Fields
    parent

    string

    Required. Name of the parent resource for the entitlement. Possible formats:

    • organizations/{organization-number}/locations/{region}
    • folders/{folder-number}/locations/{region}
    • projects/{project-id|project-number}/locations/{region}
    entitlement_id

    string

    Required. The ID to use for this entitlement. This becomes the last part of the resource name.

    This value should be 4-63 characters in length, and valid characters are "[a-z]", "[0-9]", and "-". The first character should be from [a-z].

    This value should be unique among all other entitlements under the specified parent .

    entitlement

    Entitlement

    Required. The resource being created

    request_id

    string

    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees this for at least 60 minutes after the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request and returns the previous operation's response. This prevents clients from accidentally creating duplicate entitlements.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

    CreateGrantRequest

    Message for creating a grant

    Fields
    parent

    string

    Required. Name of the parent entitlement for which this grant is being requested.
    grant

    Grant

    Required. The resource being created.
    request_id

    string

    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees this for at least 60 minutes after the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate grants.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

    DeleteEntitlementRequest

    Message for deleting an entitlement.

    Fields
    name

    string

    Required. Name of the resource.
    request_id

    string

    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees this for at least 60 minutes after the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    force

    bool

    Optional. If set to true, any child grant under this entitlement is also deleted. (Otherwise, the request only works if the entitlement has no child grant.)

    DenyGrantRequest

    Request message for DenyGrant method.

    Fields
    name

    string

    Required. Name of the grant resource which is being denied.
    reason

    string

    Optional. The reason for denying this grant. This is required if require_approver_justification field of the ManualApprovals workflow used in this grant is true.

    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.

    Fields
    name

    string

    Identifier. Name of the entitlement. Possible formats:

    • organizations/{organization-number}/locations/{region}/entitlements/{entitlement-id}
    • folders/{folder-number}/locations/{region}/entitlements/{entitlement-id}
    • projects/{project-id|project-number}/locations/{region}/entitlements/{entitlement-id}
    create_time

    Timestamp

    Output only. Create time stamp.

    update_time

    Timestamp

    Output only. Update time stamp.

    eligible_users[]

    AccessControlEntry

    Optional. Who can create grants using this entitlement. This list should contain at most one entry.

    approval_workflow

    ApprovalWorkflow

    Optional. The approvals needed before access are granted to a requester. No approvals are needed if this field is null.

    privileged_access

    PrivilegedAccess

    The access granted to a requester on successful approval.

    max_request_duration

    Duration

    Required. The maximum amount of time that access is granted for a request. A requester can ask for a duration less than this, but never more.

    state

    State

    Output only. Current state of this entitlement.

    requester_justification_config

    RequesterJustificationConfig

    Required. The manner in which the requester should provide a justification for requesting access.

    additional_notification_targets

    AdditionalNotificationTargets

    Optional. Additional email addresses to be notified based on actions taken.

    etag

    string

    An etag is used for optimistic concurrency control as a way to prevent simultaneous updates to the same entitlement. An etag is returned in the response to GetEntitlement and the caller should put the etag in the request to UpdateEntitlement so that their change is applied on the same version. If this field is omitted or if there is a mismatch while updating an entitlement, then the server rejects the request.

    AdditionalNotificationTargets

    AdditionalNotificationTargets includes email addresses to be notified.

    Fields
    admin_email_recipients[]

    string

    Optional. Additional email addresses to be notified when a principal (requester) is granted access.
    requester_email_recipients[]

    string

    Optional. Additional email address to be notified about an eligible entitlement.

    RequesterJustificationConfig

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

    Fields
    Union field justification_type . This is a required field and the user must explicitly opt out if a justification from the requester isn't mandatory. justification_type can be only one of the following:
    not_mandatory

    NotMandatory

    This option means the requester isn't required to provide a justification.

    unstructured

    Unstructured

    This option means the requester must provide a string as justification. If this is selected, the server allows the requester to provide a justification but doesn't validate it.

    NotMandatory

    This type has no fields.

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

    Unstructured

    This type has no fields.

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

    State

    Different states an entitlement can be in.

    Enums
    STATE_UNSPECIFIED Unspecified state. This value is never returned by the server.
    CREATING The entitlement is being created.
    AVAILABLE The entitlement is available for requesting access.
    DELETING The entitlement is being deleted.
    DELETED The entitlement has been deleted.
    UPDATING The entitlement is being updated.

    FetchEffectiveSettingsRequest

    Request message for FetchEffectiveSettings method.

    Fields
    parent

    string

    Required. The resource for which the effective settings should be fetched. Should be in one of the following formats:

    • projects/{project-number|project-id}/locations/{region}
    • folders/{folder-number}/locations/{region}
    • organizations/{organization-number}/locations/{region}

    FetchEffectiveSettingsResponse

    The effective value of the settings at the given location resource, evaluated based on the crm resource hierarchy.

    Fields
    parent

    string

    Output only. The resource on which the settings are effective. Possible formats:

    • projects/{project-number|project-id}/locations/{region}
    • folders/{folder-number}/locations/{region}
    • organizations/{organization-number}/locations/{region}
    email_notification_settings

    EmailNotificationSettings

    Output only. EmailNotificationSettings defines effective node-wide email notification preferences for various PAM events.

    EmailNotificationSettings

    EmailNotificationSettings reflects the effective node-wide email notification settings.

    Fields
    source

    string

    Output only. The name of the resource from which the notification behavior is inherited. This field remains empty if the setting is not defined at either the parent or resource level, in which case PAM's default behavior is applied.

    Union field notification_behavior . Notification behavior. notification_behavior can be only one of the following:
    disable_all_notifications

    DisableAllNotifications

    Output only. Disable all notifications.

    custom_notification_behavior

    CustomNotificationBehavior

    Output only. Granular settings of notifications.

    CustomNotificationBehavior

    CustomNotificationBehavior reflects the granular notification delivery settings for specific events and personas, as configured by the admin.

    Fields
    requester_notifications

    RequesterNotifications

    Output only. Requester email notifications.
    admin_notifications

    AdminNotifications

    Output only. Admin email notifications.
    approver_notifications

    ApproverNotifications

    Output only. Approver email notifications.

    AdminNotifications

    Email notifications specific to Admins.

    Fields
    notify_grant_activated

    bool

    Output only. Notification delivery for grant activated.
    notify_grant_ended

    bool

    Output only. Notification delivery for grant ended.
    notify_grant_externally_modified

    bool

    Output only. Notification delivery for grant externally modified.
    notify_grant_activation_failed

    bool

    Output only. Notification delivery for grant activation failed.

    ApproverNotifications

    Email notifications specific to Approvers.

    Fields
    notify_pending_approval

    bool

    Output only. Notification delivery for pending approval.

    RequesterNotifications

    Email notifications specific to Requesters.

    Fields
    notify_entitlement_assigned

    bool

    Output only. Notification delivery for entitlement assigned.
    notify_grant_activated

    bool

    Output only. Notification delivery for grant activated.
    notify_grant_denied

    bool

    Output only. Notification delivery for grant denied.
    notify_grant_expired

    bool

    Output only. Notification delivery for grant request expired.
    notify_grant_ended

    bool

    Output only. Notification delivery for grant ended.
    notify_grant_revoked

    bool

    Output only. Notification delivery for grant revoked.
    notify_grant_externally_modified

    bool

    Output only. Notification delivery for grant externally modified.
    notify_grant_activation_failed

    bool

    Output only. Notification delivery for grant activation failed.

    DisableAllNotifications

    This type has no fields.

    This option indicates that all email notifications are disabled.

    ServiceAccountApproverSettings

    This controls whether service accounts are allowed to approve grants or can be designated as approvers within PAM entitlements.

    Fields
    enabled

    bool

    Output only. Indicates whether service account is allowed to grant approvals.
    source

    string

    Output only. The resource from which the service account approver setting is inherited. This field remains empty if the setting is not defined at either the parent or resource level, in which case PAM's default behavior is applied.

    GetEntitlementRequest

    Message for getting an entitlement.

    Fields
    name

    string

    Required. Name of the resource.

    GetGrantRequest

    Message for getting a grant.

    Fields
    name

    string

    Required. Name of the resource.

    GetSettingsRequest

    Request message for GetSettings method.

    Fields
    name

    string

    Required. The name of the settings resource to be fetched.

    Grant

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

    Fields
    name

    string

    Identifier. Name of this grant. Possible formats:

    • organizations/{organization-number}/locations/{region}/entitlements/{entitlement-id}/grants/{grant-id}
    • folders/{folder-number}/locations/{region}/entitlements/{entitlement-id}/grants/{grant-id}
    • projects/{project-id|project-number}/locations/{region}/entitlements/{entitlement-id}/grants/{grant-id}

    The last segment of this name ( {grant-id} ) is autogenerated.

    create_time

    Timestamp

    Output only. Create time stamp.

    update_time

    Timestamp

    Output only. Update time stamp.

    requester

    string

    Output only. Username of the user who created this grant.

    requested_duration

    Duration

    Required. The amount of time access is needed for. This value should be less than the max_request_duration value of the entitlement.

    justification

    Justification

    Optional. Justification of why this access is needed.

    state

    State

    Output only. Current state of this grant.

    timeline

    Timeline

    Output only. Timeline of this grant.

    privileged_access

    PrivilegedAccess

    Output only. The access that would be granted by this grant.

    requested_privileged_access[]

    RequestedPrivilegedAccess

    Optional. The accesses requested to be granted by this grant.

    audit_trail

    AuditTrail

    Output only. Audit trail of access provided by this grant. If unspecified then access was never granted.

    additional_email_recipients[]

    string

    Optional. Additional email addresses to notify for all the actions performed on the grant.

    externally_modified

    bool

    Output only. Flag set by the PAM system to indicate that policy bindings made by this grant have been modified from outside PAM.

    After it is set, this flag remains set forever irrespective of the grant state. A true value here indicates that PAM no longer has any certainty on the access a user has because of this grant.

    AuditTrail

    Audit trail for the access provided by this grant.

    Fields
    access_grant_time

    Timestamp

    Output only. The time at which access was given.
    access_remove_time

    Timestamp

    Output only. The time at which the system removed access. This could be because of an automatic expiry or because of a revocation.

    If unspecified, then access hasn't been removed yet.

    State

    Different states a grant can be in.

    Enums
    STATE_UNSPECIFIED Unspecified state. This value is never returned by the server.
    APPROVAL_AWAITED The entitlement had an approval workflow configured and this grant is waiting for the workflow to complete.
    DENIED The approval workflow completed with a denied result. No access is granted for this grant. This is a terminal state.
    SCHEDULED The approval workflow completed successfully with an approved result or none was configured. Access is provided at an appropriate time.
    ACTIVATING Access is being given.
    ACTIVE Access was successfully given and is currently active.
    ACTIVATION_FAILED The system could not give access due to a non-retriable error. This is a terminal state.
    EXPIRED Expired after waiting for the approval workflow to complete. This is a terminal state.
    REVOKING Access is being revoked.
    REVOKED Access was revoked by a user. This is a terminal state.
    ENDED System took back access as the requested duration was over. This is a terminal state.
    WITHDRAWING Access is being withdrawn.
    WITHDRAWN Grant was withdrawn by the grant owner. This is a terminal state.

    Timeline

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

    Fields
    events[]

    Event

    Output only. The events that have occurred on this grant. This list contains entries in the same order as they occurred. The first entry is always be of type Requested and there is always at least one entry in this array.

    Event

    A single operation on the grant.

    Fields
    event_time

    Timestamp

    Output only. The time (as recorded at server) when this event occurred.

    Union field event .

    event can be only one of the following:

    requested

    Requested

    The grant was requested.

    approved

    Approved

    The grant was approved.

    denied

    Denied

    The grant was denied.

    revoked

    Revoked

    The grant was revoked.

    scheduled

    Scheduled

    The grant has been scheduled to give access.

    activated

    Activated

    The grant was successfully activated to give access.

    activation_failed

    ActivationFailed

    There was a non-retriable error while trying to give access.

    expired

    Expired

    The approval workflow did not complete in the necessary duration, and so the grant is expired.

    ended

    Ended

    Access given by the grant ended automatically as the approved duration was over.

    externally_modified

    ExternallyModified

    The policy bindings made by grant have been modified outside of PAM.

    withdrawn

    Withdrawn

    The grant was withdrawn.

    Activated

    This type has no fields.

    An event representing that the grant was successfully activated.

    ActivationFailed

    An event representing that the grant activation failed.

    Fields
    error

    Status

    Output only. The error that occurred while activating the grant.

    Approved

    An event representing that the grant was approved.

    Fields
    reason

    string

    Output only. The reason provided by the approver for approving the grant.
    actor

    string

    Output only. Username of the user who approved the grant.
    step_id

    string

    Output only. The ID of the approval workflow step that was approved.

    Denied

    An event representing that the grant was denied.

    Fields
    reason

    string

    Output only. The reason provided by the approver for denying the grant.
    actor

    string

    Output only. Username of the user who denied the grant.
    step_id

    string

    Output only. The ID of the approval workflow step that was denied.

    Ended

    This type has no fields.

    An event representing that the grant has ended.

    Expired

    This type has no fields.

    An event representing that the grant was expired.

    ExternallyModified

    This type has no fields.

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

    Requested

    An event representing that a grant was requested.

    Fields
    expire_time

    Timestamp

    Output only. The time at which this grant expires unless the approval workflow completes. If omitted, then the request never expires.

    Revoked

    An event representing that the grant was revoked.

    Fields
    reason

    string

    Output only. The reason provided by the user for revoking the grant.
    actor

    string

    Output only. Username of the user who revoked the grant.

    Scheduled

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

    Fields
    scheduled_activation_time

    Timestamp

    Output only. The time at which the access is granted.

    Withdrawn

    This type has no fields.

    An event representing that the grant was withdrawn.

    Justification

    Justification represents a justification for requesting access.

    Fields

    Union field justification .

    justification can be only one of the following:

    unstructured_justification

    string

    A free form textual justification. The system only ensures that this is not empty. No other kind of validation is performed on the string.

    ListEntitlementsRequest

    Message for requesting list of entitlements.

    Fields
    parent

    string

    Required. The parent which owns the entitlement resources.
    page_size

    int32

    Optional. Requested page size. Server may return fewer items than requested. If unspecified, the server picks an appropriate default.
    page_token

    string

    Optional. A token identifying a page of results the server should return.
    filter

    string

    Optional. Filtering results.
    order_by

    string

    Optional. Hint for how to order the results.

    ListEntitlementsResponse

    Message for response to listing entitlements.

    Fields
    entitlements[]

    Entitlement

    The list of entitlements.
    next_page_token

    string

    A token identifying a page of results the server should return.
    unreachable[]

    string

    Locations that could not be reached.

    ListGrantsRequest

    Message for requesting list of grants.

    Fields
    parent

    string

    Required. The parent resource which owns the grants.
    page_size

    int32

    Optional. Requested page size. The server may return fewer items than requested. If unspecified, the server picks an appropriate default.
    page_token

    string

    Optional. A token identifying a page of results the server should return.
    filter

    string

    Optional. Filtering results.
    order_by

    string

    Optional. Hint for how to order the results

    ListGrantsResponse

    Message for response to listing grants.

    Fields
    grants[]

    Grant

    The list of grants.
    next_page_token

    string

    A token identifying a page of results the server should return.
    unreachable[]

    string

    Locations that could not be reached.

    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.

    Fields
    require_approver_justification

    bool

    Optional. Do the approvers need to provide a justification for their actions?
    steps[]

    Step

    Optional. List of approval steps in this workflow. These steps are followed in the specified order sequentially. Only 1 step is supported.

    Step

    Step represents a logical step in a manual approval workflow.

    Fields
    approvers[]

    AccessControlEntry

    Optional. The potential set of approvers in this step. This list must contain at most one entry.
    approvals_needed

    int32

    Required. How many users from the above list need to approve. If there aren't enough distinct users in the list, then the workflow indefinitely blocks. Should always be greater than 0. 1 is the only supported value.
    approver_email_recipients[]

    string

    Optional. Additional email addresses to be notified when a grant is pending approval.
    id

    string

    Output only. Step ID used to identify the step in the workflow.

    OperationMetadata

    Represents the metadata of the long-running operation.

    Fields
    create_time

    Timestamp

    Output only. The time the operation was created.
    end_time

    Timestamp

    Output only. The time the operation finished running.
    target

    string

    Output only. Server-defined resource path for the target of the operation.
    verb

    string

    Output only. Name of the verb executed by the operation.
    status_message

    string

    Output only. Human-readable status of the operation, if any.
    requested_cancellation

    bool

    Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have [Operation.error][] value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED .
    api_version

    string

    Output only. API version used to start the operation.

    PrivilegedAccess

    Privileged access that this service can be used to gate.

    Fields

    Union field access_type .

    access_type can be only one of the following:

    gcp_iam_access

    GcpIamAccess

    Access to a Google Cloud resource through IAM.

    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.

    Fields
    resource_type

    string

    Required. The type of this resource.
    resource

    string

    Required. Name of the resource.
    role_bindings[]

    RoleBinding

    Required. Role bindings that are created on successful grant.

    RoleBinding

    IAM role bindings that are created after a successful grant.

    Fields
    role

    string

    Required. IAM role to be granted. https://cloud.google.com/iam/docs/roles-overview .
    condition_expression

    string

    Optional. The expression field of the IAM condition to be associated with the role. If specified, a user with an active grant for this entitlement is able to access the resource only if this condition evaluates to true for their request.

    This field uses the same CEL format as IAM and supports all attributes that IAM supports, except tags. https://cloud.google.com/iam/docs/conditions-overview#attributes .
    id

    string

    Output only. The ID corresponding to this role binding in the policy binding. This will be unique within an entitlement across time. Gets re-generated each time the entitlement is updated.

    RequestedPrivilegedAccess

    Privileged access that is requested by a user via a grant.

    Fields
    Union field access_type . Type of access that is requested. Only GCP IAM based access is supported for now. access_type can be only one of the following:
    gcp_iam_access

    GcpIamAccess

    Access to a Google Cloud resource through IAM.

    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.

    Fields
    resource_type

    string

    Required. The type of this resource.
    resource

    string

    Required. Name of the resource.
    role_bindings[]

    RoleBinding

    Optional. Role bindings that are requested as part of the grant.

    AccessRestrictions

    AccessRestrictions represents a set of resources to further restrict the access to. This is used to get finer grained access as part of a grant. All restrictions are OR-ed with each other.

    Fields
    resource_names[]

    string

    Optional. The resource names to restrict the access to. Follow https://cloud.google.com/iam/docs/conditions-resource-attributes#resource-name format.
    resource_name_prefixes[]

    string

    Optional. The resource name prefixes to restrict the access to. Follow https://cloud.google.com/iam/docs/conditions-resource-attributes#resource-name format.

    RoleBinding

    IAM role bindings that are requested as part of the grant.

    Fields
    entitlement_role_binding_id

    string

    Required. The role binding id of the role to be granted from the entitlement.
    access_restrictions

    AccessRestrictions

    Optional. The access restrictions to be applied to the role binding. This further restricts the access of this role binding to specific resources.
    role

    string

    Output only. The IAM role requested as part of the grant.
    entitlement_condition_expression

    string

    Output only. The IAM condition expression associated with the role at the time of grant request.

    RevokeGrantRequest

    Request message for RevokeGrant method.

    Fields
    name

    string

    Required. Name of the grant resource which is being revoked.
    reason

    string

    Optional. The reason for revoking this grant.

    SearchEntitlementsRequest

    Request message for SearchEntitlements method.

    Fields
    parent

    string

    Required. The parent which owns the entitlement resources.
    caller_access_type

    CallerAccessType

    Required. Only entitlements where the calling user has this access are returned.
    filter

    string

    Optional. Only entitlements matching this filter are returned in the response.
    page_size

    int32

    Optional. Requested page size. The server may return fewer items than requested. If unspecified, the server picks an appropriate default.
    page_token

    string

    Optional. A token identifying a page of results the server should return.

    CallerAccessType

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

    Enums
    CALLER_ACCESS_TYPE_UNSPECIFIED Unspecified access type.
    GRANT_REQUESTER The user has access to create grants using this entitlement.
    GRANT_APPROVER The user has access to approve/deny grants created under this entitlement.

    SearchEntitlementsResponse

    Response message for SearchEntitlements method.

    Fields
    entitlements[]

    Entitlement

    The list of entitlements.
    next_page_token

    string

    A token identifying a page of results the server should return.

    SearchGrantsRequest

    Request message for SearchGrants method.

    Fields
    parent

    string

    Required. The parent which owns the grant resources.
    caller_relationship

    CallerRelationshipType

    Required. Only grants which the caller is related to by this relationship are returned in the response.
    filter

    string

    Optional. Only grants matching this filter are returned in the response.
    page_size

    int32

    Optional. Requested page size. The server may return fewer items than requested. If unspecified, server picks an appropriate default.
    page_token

    string

    Optional. A token identifying a page of results the server should return.

    CallerRelationshipType

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

    Enums
    CALLER_RELATIONSHIP_TYPE_UNSPECIFIED Unspecified caller relationship type.
    HAD_CREATED The user created this grant by calling CreateGrant earlier.
    CAN_APPROVE The user is an approver for the entitlement that this grant is parented under and can currently approve/deny it.
    HAD_APPROVED The caller had successfully approved/denied this grant earlier.

    SearchGrantsResponse

    Response message for SearchGrants method.

    Fields
    grants[]

    Grant

    The list of grants.
    next_page_token

    string

    A token identifying a page of results the server should return.

    Settings

    Settings resource defines the properties, applied directly to the resource or inherited through the hierarchy, to enable consistent, federated use of PAM.

    The behavior is as follows: 1. If explicitly set to empty at the node level, PAM's default settings are applied for that node. 2. If not set at the node level, settings are inherited from the closest ancestor with a non-empty value. If none of the ancestors has the field set, PAM's default settings are applied. 3. If explicitly set to a non-empty value at the node level, the specified settings are applied for that node.

    Fields
    name

    string

    Identifier. Name of the settings resource. Possible formats: projects/{project-id|project-number}/locations/{location}/settings folders/{folder-number}/locations/{location}/settings organizations/{organization-number}/locations/{location}/settings
    create_time

    Timestamp

    Output only. Create timestamp.
    update_time

    Timestamp

    Output only. Update timestamp.
    etag

    string

    Fingerprint for optimistic concurrency returned in the response of GetSettings . Must be provided in the requests to UpdateSettings . If the value provided does not match the value known to the server, ABORTED will be thrown, and the client should retry the read-modify-write cycle.
    email_notification_settings

    EmailNotificationSettings

    Optional. EmailNotificationSettings defines node-wide email notification preferences for various PAM events.

    EmailNotificationSettings

    EmailNotificationSettings defines the node-wide email notification settings.

    Fields
    Union field notification_behavior . Notification behavior. 1. If set to DisableAllNotifications , all notifications are disabled for the node. 2. If set to CustomNotificationBehavior , notifications are customized as per the specified settings. 3. If notification_behavior is not set (none of the options selected), PAM's default settings are applied for that node. notification_behavior can be only one of the following:
    disable_all_notifications

    DisableAllNotifications

    Disable all notifications.

    custom_notification_behavior

    CustomNotificationBehavior

    Granular settings of notifications.

    CustomNotificationBehavior

    CustomNotificationBehavior provides granular control over email notification delivery. Allows admins to selectively enable/disable notifications for specific events and specific personas.

    Fields
    requester_notifications

    RequesterNotifications

    Optional. Requester email notifications.
    admin_notifications

    AdminNotifications

    Optional. Admin email notifications.
    approver_notifications

    ApproverNotifications

    Optional. Approver email notifications.

    AdminNotifications

    Email notifications specific to Admins.

    Fields
    grant_activated

    NotificationMode

    Optional. Notification mode for grant activated.
    grant_ended

    NotificationMode

    Optional. Notification mode for grant ended.
    grant_externally_modified

    NotificationMode

    Optional. Notification mode for grant externally modified.
    grant_activation_failed

    NotificationMode

    Optional. Notification mode for grant activation failed.

    ApproverNotifications

    Email notifications specific to Approvers.

    Fields
    pending_approval

    NotificationMode

    Optional. Notification mode for pending approval.

    NotificationMode

    NotificationMode represents the notification delivery setting.

    Enums
    NOTIFICATION_MODE_UNSPECIFIED Default notification behavior following PAM's standard settings.
    ENABLED Notifications are enabled.
    DISABLED Notifications are disabled.

    RequesterNotifications

    Email notifications specific to Requesters.

    Fields
    entitlement_assigned

    NotificationMode

    Optional. Notification mode for entitlement assigned.
    grant_activated

    NotificationMode

    Optional. Notification mode for grant activated.
    grant_denied

    NotificationMode

    Optional. Notification mode for grant denied.
    grant_expired

    NotificationMode

    Optional. Notification mode for grant request expired.
    grant_ended

    NotificationMode

    Optional. Notification mode for grant ended.
    grant_revoked

    NotificationMode

    Optional. Notification mode for grant revoked.
    grant_externally_modified

    NotificationMode

    Optional. Notification mode for grant externally modified.
    grant_activation_failed

    NotificationMode

    Optional. Notification mode for grant activation failed.

    DisableAllNotifications

    This type has no fields.

    This option indicates that all email notifications are disabled.

    ServiceAccountApproverSettings

    This controls whether service accounts are allowed to approve grants or can be designated as approvers within PAM entitlements.

    Fields
    enabled

    bool

    Optional. Indicates whether service account is allowed to grant approvals.

    UpdateEntitlementRequest

    Message for updating an entitlement.

    Fields
    entitlement

    Entitlement

    Required. The entitlement resource that is updated.
    update_mask

    FieldMask

    Required. The list of fields to update. A field is overwritten if, and only if, it is in the mask. Any immutable fields set in the mask are ignored by the server. Repeated fields and map fields are only allowed in the last position of a paths string and overwrite the existing values. Hence an update to a repeated field or a map should contain the entire list of values. The fields specified in the update_mask are relative to the resource and not to the request. (e.g. MaxRequestDuration ; not entitlement.MaxRequestDuration ) A value of '*' for this field refers to full replacement of the resource.

    UpdateSettingsRequest

    Request message for UpdateSettings method.

    Fields
    settings

    Settings

    Required. The settings resource to be updated.
    update_mask

    FieldMask

    Required. The list of fields to update. A field is overwritten if, and only if, it is in the mask. Any immutable fields set in the mask are ignored by the server. Repeated fields and map fields are only allowed in the last position of a paths string and overwrite the existing values. Hence an update to a repeated field or a map should contain the entire list of values. The fields specified in the update_mask are relative to the resource and not to the request. A value of '*' for this field refers to full replacement of the resource.

    WithdrawGrantRequest

    Request message for WithdrawGrant method.

    Fields
    name

    string

    Required. Name of the grant resource which is being withdrawn.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: