The API has a collection of resources, named approvalRequests/{approval_request} - The API has top-level settings per Project/Folder/Organization, named accessApprovalSettings

The service also periodically emails a list of recipients, defined at the Project/Folder/Organization level in the accessApprovalSettings, when there is a pending ApprovalRequest for them to act on. The ApprovalRequests can also optionally be published to a Pub/Sub topic owned by the customer (contact support if you would like to enable Pub/Sub notifications).

ApprovalRequests can be approved or dismissed. Google personnel can only access the indicated resource or resources if the request is approved (subject to some exclusions: https://cloud.google.com/access-approval/docs/overview#exclusions).

Note: Using Access Approval functionality will mean that Google may not be able to meet the SLAs for your chosen products, as any support response times may be dramatically increased. As such the SLAs do not apply to any service disruption to the extent impacted by Customer's use of Access Approval. Do not enable Access Approval for projects where you may require high service availability and rapid response by Google Cloud Support.

After a request is approved or dismissed, no further action may be taken on it. Requests with the requested_expiration in the past or with no activity for 14 days are considered dismissed. When an approval expires, the request is considered dismissed.

If a request is not approved or dismissed, we call it pending. v1

Variables

_default

_default: {
    v1: typeof v1;
    AccessApprovalClient: typeof v1.AccessApprovalClient;
}

AccessApprovalClient

AccessApprovalClient: typeof v1.AccessApprovalClient

Type Aliases

AccessApprovalClient

type AccessApprovalClient = v1.AccessApprovalClient;

protos.google.cloud.accessapproval.v1.AccessApproval.ApproveApprovalRequestCallback

type ApproveApprovalRequestCallback = (error: (Error|null), response?: google.cloud.accessapproval.v1.ApprovalRequest) => void;

Callback as used by .

protos.google.cloud.accessapproval.v1.AccessApproval.DeleteAccessApprovalSettingsCallback

type DeleteAccessApprovalSettingsCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.cloud.accessapproval.v1.AccessApproval.DismissApprovalRequestCallback

type DismissApprovalRequestCallback = (error: (Error|null), response?: google.cloud.accessapproval.v1.ApprovalRequest) => void;

Callback as used by .

protos.google.cloud.accessapproval.v1.AccessApproval.GetAccessApprovalServiceAccountCallback

type GetAccessApprovalServiceAccountCallback = (error: (Error|null), response?: google.cloud.accessapproval.v1.AccessApprovalServiceAccount) => void;

Callback as used by .

protos.google.cloud.accessapproval.v1.AccessApproval.GetAccessApprovalSettingsCallback

type GetAccessApprovalSettingsCallback = (error: (Error|null), response?: google.cloud.accessapproval.v1.AccessApprovalSettings) => void;

Callback as used by .

protos.google.cloud.accessapproval.v1.AccessApproval.GetApprovalRequestCallback

type GetApprovalRequestCallback = (error: (Error|null), response?: google.cloud.accessapproval.v1.ApprovalRequest) => void;

Callback as used by .

protos.google.cloud.accessapproval.v1.AccessApproval.InvalidateApprovalRequestCallback

type InvalidateApprovalRequestCallback = (error: (Error|null), response?: google.cloud.accessapproval.v1.ApprovalRequest) => void;

Callback as used by .

protos.google.cloud.accessapproval.v1.AccessApproval.ListApprovalRequestsCallback

type ListApprovalRequestsCallback = (error: (Error|null), response?: google.cloud.accessapproval.v1.ListApprovalRequestsResponse) => void;

Callback as used by .

protos.google.cloud.accessapproval.v1.AccessApproval.UpdateAccessApprovalSettingsCallback

type UpdateAccessApprovalSettingsCallback = (error: (Error|null), response?: google.cloud.accessapproval.v1.AccessApprovalSettings) => void;

Callback as used by .

Package @google-cloud/access-approval (2.2.2)

Classes

Interfaces

Enums