AccessApproval

import { AccessApproval } from "https://googleapis.deno.dev/v1/accessapproval:v1.ts";

An API for controlling access to data by Google personnel.

class AccessApproval {

constructor(client?: CredentialsClient, baseUrl?: string);

async foldersApprovalRequestsApprove(name: string, req: ApproveApprovalRequestMessage): Promise<ApprovalRequest>;

async foldersApprovalRequestsDismiss(name: string, req: DismissApprovalRequestMessage): Promise<ApprovalRequest>;

async foldersApprovalRequestsGet(name: string): Promise<ApprovalRequest>;

async foldersApprovalRequestsInvalidate(name: string, req: InvalidateApprovalRequestMessage): Promise<ApprovalRequest>;

async foldersApprovalRequestsList(parent: string, opts?: FoldersApprovalRequestsListOptions): Promise<ListApprovalRequestsResponse>;

async foldersDeleteAccessApprovalSettings(name: string): Promise<Empty>;

async foldersGetAccessApprovalSettings(name: string): Promise<AccessApprovalSettings>;

async foldersGetServiceAccount(name: string): Promise<AccessApprovalServiceAccount>;

async foldersUpdateAccessApprovalSettings(

req: AccessApprovalSettings,

opts?: FoldersUpdateAccessApprovalSettingsOptions,

): Promise<AccessApprovalSettings>;

async organizationsApprovalRequestsApprove(name: string, req: ApproveApprovalRequestMessage): Promise<ApprovalRequest>;

async organizationsApprovalRequestsDismiss(name: string, req: DismissApprovalRequestMessage): Promise<ApprovalRequest>;

async organizationsApprovalRequestsGet(name: string): Promise<ApprovalRequest>;

async organizationsApprovalRequestsInvalidate(name: string, req: InvalidateApprovalRequestMessage): Promise<ApprovalRequest>;

async organizationsApprovalRequestsList(parent: string, opts?: OrganizationsApprovalRequestsListOptions): Promise<ListApprovalRequestsResponse>;

async organizationsDeleteAccessApprovalSettings(name: string): Promise<Empty>;

async organizationsGetAccessApprovalSettings(name: string): Promise<AccessApprovalSettings>;

async organizationsGetServiceAccount(name: string): Promise<AccessApprovalServiceAccount>;

async organizationsUpdateAccessApprovalSettings(

req: AccessApprovalSettings,

opts?: OrganizationsUpdateAccessApprovalSettingsOptions,

): Promise<AccessApprovalSettings>;

async projectsApprovalRequestsApprove(name: string, req: ApproveApprovalRequestMessage): Promise<ApprovalRequest>;

async projectsApprovalRequestsDismiss(name: string, req: DismissApprovalRequestMessage): Promise<ApprovalRequest>;

async projectsApprovalRequestsGet(name: string): Promise<ApprovalRequest>;

async projectsApprovalRequestsInvalidate(name: string, req: InvalidateApprovalRequestMessage): Promise<ApprovalRequest>;

async projectsApprovalRequestsList(parent: string, opts?: ProjectsApprovalRequestsListOptions): Promise<ListApprovalRequestsResponse>;

async projectsDeleteAccessApprovalSettings(name: string): Promise<Empty>;

async projectsGetAccessApprovalSettings(name: string): Promise<AccessApprovalSettings>;

async projectsGetServiceAccount(name: string): Promise<AccessApprovalServiceAccount>;

async projectsUpdateAccessApprovalSettings(

req: AccessApprovalSettings,

opts?: ProjectsUpdateAccessApprovalSettingsOptions,

): Promise<AccessApprovalSettings>;

}

§Constructors

new AccessApproval(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

foldersApprovalRequestsApprove(name: string, req: ApproveApprovalRequestMessage): Promise<ApprovalRequest>

[src]

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.

@param name

Name of the approval request to approve.

foldersApprovalRequestsDismiss(name: string, req: DismissApprovalRequestMessage): Promise<ApprovalRequest>

[src]

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.

@param name

Name of the ApprovalRequest to dismiss.

foldersApprovalRequestsGet(name: string): Promise<ApprovalRequest>

[src]

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

@param name

The name of the approval request to retrieve. Format: "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}"

foldersApprovalRequestsInvalidate(name: string, req: InvalidateApprovalRequestMessage): Promise<ApprovalRequest>

[src]

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.

@param name

Name of the ApprovalRequest to invalidate.

foldersApprovalRequestsList(parent: string, opts?: FoldersApprovalRequestsListOptions): Promise<ListApprovalRequestsResponse>

[src]

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.

@param parent

The parent resource. This may be "projects/{project}", "folders/{folder}", or "organizations/{organization}".

foldersDeleteAccessApprovalSettings(name: string): Promise<Empty>

[src]

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.

@param name

Name of the AccessApprovalSettings to delete.

foldersGetAccessApprovalSettings(name: string): Promise<AccessApprovalSettings>

[src]

Gets the settings associated with a project, folder, or organization.

@param name

The name of the AccessApprovalSettings to retrieve. Format: "{projects|folders|organizations}/{id}/accessApprovalSettings"

foldersGetServiceAccount(name: string): Promise<AccessApprovalServiceAccount>

[src]

Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.

@param name

Name of the AccessApprovalServiceAccount to retrieve.

foldersUpdateAccessApprovalSettings(name: string, req: AccessApprovalSettings, opts?: FoldersUpdateAccessApprovalSettingsOptions): Promise<AccessApprovalSettings>

[src]

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

@param name

The resource name of the settings. Format is one of: * "projects/{project}/accessApprovalSettings" * "folders/{folder}/accessApprovalSettings" * "organizations/{organization}/accessApprovalSettings"

organizationsApprovalRequestsApprove(name: string, req: ApproveApprovalRequestMessage): Promise<ApprovalRequest>

[src]

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.

@param name

Name of the approval request to approve.

organizationsApprovalRequestsDismiss(name: string, req: DismissApprovalRequestMessage): Promise<ApprovalRequest>

[src]

@param name

Name of the ApprovalRequest to dismiss.

organizationsApprovalRequestsGet(name: string): Promise<ApprovalRequest>

[src]

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

@param name

The name of the approval request to retrieve. Format: "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}"

organizationsApprovalRequestsInvalidate(name: string, req: InvalidateApprovalRequestMessage): Promise<ApprovalRequest>

[src]

@param name

Name of the ApprovalRequest to invalidate.

organizationsApprovalRequestsList(parent: string, opts?: OrganizationsApprovalRequestsListOptions): Promise<ListApprovalRequestsResponse>

[src]

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.

@param parent

The parent resource. This may be "projects/{project}", "folders/{folder}", or "organizations/{organization}".

organizationsDeleteAccessApprovalSettings(name: string): Promise<Empty>

[src]

@param name

Name of the AccessApprovalSettings to delete.

organizationsGetAccessApprovalSettings(name: string): Promise<AccessApprovalSettings>

[src]

Gets the settings associated with a project, folder, or organization.

@param name

The name of the AccessApprovalSettings to retrieve. Format: "{projects|folders|organizations}/{id}/accessApprovalSettings"

organizationsGetServiceAccount(name: string): Promise<AccessApprovalServiceAccount>

[src]

Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.

@param name

Name of the AccessApprovalServiceAccount to retrieve.

organizationsUpdateAccessApprovalSettings(name: string, req: AccessApprovalSettings, opts?: OrganizationsUpdateAccessApprovalSettingsOptions): Promise<AccessApprovalSettings>

[src]

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

@param name

The resource name of the settings. Format is one of: * "projects/{project}/accessApprovalSettings" * "folders/{folder}/accessApprovalSettings" * "organizations/{organization}/accessApprovalSettings"

projectsApprovalRequestsApprove(name: string, req: ApproveApprovalRequestMessage): Promise<ApprovalRequest>

[src]

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.

@param name

Name of the approval request to approve.

projectsApprovalRequestsDismiss(name: string, req: DismissApprovalRequestMessage): Promise<ApprovalRequest>

[src]

@param name

Name of the ApprovalRequest to dismiss.

projectsApprovalRequestsGet(name: string): Promise<ApprovalRequest>

[src]

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

@param name

The name of the approval request to retrieve. Format: "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}"

projectsApprovalRequestsInvalidate(name: string, req: InvalidateApprovalRequestMessage): Promise<ApprovalRequest>

[src]

@param name

Name of the ApprovalRequest to invalidate.

projectsApprovalRequestsList(parent: string, opts?: ProjectsApprovalRequestsListOptions): Promise<ListApprovalRequestsResponse>

[src]

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.

@param parent

The parent resource. This may be "projects/{project}", "folders/{folder}", or "organizations/{organization}".

projectsDeleteAccessApprovalSettings(name: string): Promise<Empty>

[src]

@param name

Name of the AccessApprovalSettings to delete.

projectsGetAccessApprovalSettings(name: string): Promise<AccessApprovalSettings>

[src]

Gets the settings associated with a project, folder, or organization.

@param name

The name of the AccessApprovalSettings to retrieve. Format: "{projects|folders|organizations}/{id}/accessApprovalSettings"

projectsGetServiceAccount(name: string): Promise<AccessApprovalServiceAccount>

[src]

Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.

@param name

Name of the AccessApprovalServiceAccount to retrieve.

projectsUpdateAccessApprovalSettings(name: string, req: AccessApprovalSettings, opts?: ProjectsUpdateAccessApprovalSettingsOptions): Promise<AccessApprovalSettings>

[src]

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

@param name

The resource name of the settings. Format is one of: * "projects/{project}/accessApprovalSettings" * "folders/{folder}/accessApprovalSettings" * "organizations/{organization}/accessApprovalSettings"