APIHub
Back to Explore

Access Approval API

An API for controlling access to data by Google personnel.

Analytics
OAuth
HTTPS
CORS: Unknown
Visit official documentation

Latency

Not monitored yet

Uptime

Not monitored yet

Playground

Verified

live

Endpoints

REST · JSON
DELETE

/v1/{name}

Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.

  • name (path, required) — Name of the AccessApprovalSettings to delete.
GET

/v1/{name}

Gets an approval request. Returns NOT_FOUND if the request does not exist.

  • name (path, required) — The name of the approval request to retrieve. Format: "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}"
PATCH

/v1/{name}

Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.

  • name (path, required) — The resource name of the settings. Format is one of: * "projects/{project}/accessApprovalSettings" * "folders/{folder}/accessApprovalSettings" * "organizations/{organization}/accessApprovalSettings"
  • updateMask (query) — The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails & enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If this field is left unset, only the notification_emails field will be updated.
POST

/v1/{name}:approve

Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

  • name (path, required) — Name of the approval request to approve.
POST

/v1/{name}:dismiss

Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

  • name (path, required) — Name of the ApprovalRequest to dismiss.
POST

/v1/{name}:invalidate

Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.

  • name (path, required) — Name of the ApprovalRequest to invalidate.
GET

/v1/{parent}/approvalRequests

Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.

  • parent (path, required) — The parent resource. This may be "projects/{project}", "folders/{folder}", or "organizations/{organization}".
  • filter (query) — A filter on the type of approval requests to retrieve. Must be one of the following values: * [not set]: Requests that are pending or have active approvals. * ALL: All requests. * PENDING: Only pending requests. * ACTIVE: Only active (i.e. currently approved) requests. * DISMISSED: Only requests that have been dismissed, or requests that are not approved and past expiration. * EXPIRED: Only requests that have been approved, and the approval has expired. * HISTORY: Active, dismissed and expired requests.
  • pageSize (query, limit) — Requested page size.
  • pageToken (query) — A token identifying the page of results to return.

7 endpoints auto-detected

Authentication

This API requires authentication: OAuth.

curl -X DELETE \
  "https://accessapproval.googleapis.com/v1/{name}"

accessapproval.googleapis.com · HTTPS only