import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace accessapproval_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Access Approval API
*
* An API for controlling access to data by Google personnel.
*
* @example
* ```js
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
* ```
*/
export class Accessapproval {
context: APIRequestContext;
folders: Resource$Folders;
organizations: Resource$Organizations;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Access Approval service account related to a project/folder/organization.
*/
export interface Schema$AccessApprovalServiceAccount {
/**
* Email address of the service account.
*/
accountEmail?: string | null;
/**
* The resource name of the Access Approval service account. Format is one of: * "projects/{project\}/serviceAccount" * "folders/{folder\}/serviceAccount" * "organizations/{organization\}/serviceAccount"
*/
name?: string | null;
}
/**
* Settings on a Project/Folder/Organization related to Access Approval.
*/
export interface Schema$AccessApprovalSettings {
/**
* The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of this resource, and new non-empty values may not be set.
*/
activeKeyVersion?: string | null;
/**
* Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that an ancestor of this Project or Folder has set active_key_version (this field will always be unset for the organization since organizations do not have ancestors).
*/
ancestorHasActiveKeyVersion?: boolean | null;
/**
* Optional. Policy configuration for Access Approval that sets the operating mode. The available policies are Transparency, Streamlined Support, and Approval Required.
*/
approvalPolicy?: Schema$CustomerApprovalApprovalPolicy;
/**
* Output only. Effective policy applied for Access Approval, inclusive of inheritance.
*/
effectiveApprovalPolicy?: Schema$CustomerApprovalApprovalPolicy;
/**
* Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors).
*/
enrolledAncestor?: boolean | null;
/**
* A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded.
*/
enrolledServices?: Schema$EnrolledService[];
/**
* Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that there is some configuration issue with the active_key_version configured at this level in the resource hierarchy (e.g. it doesn't exist or the Access Approval service account doesn't have the correct permissions on it, etc.) This key version is not necessarily the effective key version at this level, as key versions are inherited top-down.
*/
invalidKeyVersion?: boolean | null;
/**
* The resource name of the settings. Format is one of: * "projects/{project\}/accessApprovalSettings" * "folders/{folder\}/accessApprovalSettings" * "organizations/{organization\}/accessApprovalSettings"
*/
name?: string | null;
/**
* A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed.
*/
notificationEmails?: string[] | null;
/**
* Optional. A pubsub topic that notifications relating to access approval are published to. Notifications include pre-approved accesses.
*/
notificationPubsubTopic?: string | null;
/**
* This field is used to set a preference for granularity of an access approval request. If true, Google personnel will be asked to send resource-level requests when possible. If false, Google personnel will be asked to send requests at the project level.
*/
preferNoBroadApprovalRequests?: boolean | null;
/**
* Set the default access approval request expiration time. This value is able to be set directly by the customer at the time of approval, overriding this suggested value. We recommend setting this value to 30 days.
*/
preferredRequestExpirationDays?: number | null;
/**
* Optional. A setting that indicates the maximum scope of an Access Approval request: either organization, folder, or project. Google administrators will be asked to send requests no broader than the configured scope.
*/
requestScopeMaxWidthPreference?: string | null;
/**
* Optional. When enabled, Google will only be able to send approval requests for access reasons with a customer accessible case ID in the reason detail. Also known as "Require customer initiated support case justification"
*/
requireCustomerVisibleJustification?: boolean | null;
}
/**
* Physical assigned office and physical location of the Google administrator performing the access.
*/
export interface Schema$AccessLocations {
/**
* The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
*/
principalOfficeCountry?: string | null;
/**
* Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
*/
principalPhysicalLocationCountry?: string | null;
}
export interface Schema$AccessReason {
/**
* More detail about certain reason types. See comments for each type above.
*/
detail?: string | null;
/**
* Type of access reason.
*/
type?: string | null;
}
/**
* A request for the customer to approve access to a resource.
*/
export interface Schema$ApprovalRequest {
/**
* Access was approved.
*/
approve?: Schema$ApproveDecision;
/**
* The request was dismissed.
*/
dismiss?: Schema$DismissDecision;
/**
* The resource name of the request. Format is "{projects|folders|organizations\}/{id\}/approvalRequests/{approval_request\}".
*/
name?: string | null;
/**
* This field contains the augmented information of the request.
*/
requestedAugmentedInfo?: Schema$AugmentedInfo;
/**
* The requested access duration.
*/
requestedDuration?: string | null;
/**
* The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time.
*/
requestedExpiration?: string | null;
/**
* The locations for which approval is being requested.
*/
requestedLocations?: Schema$AccessLocations;
/**
* The access reason for which approval is being requested.
*/
requestedReason?: Schema$AccessReason;
/**
* The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification.
*/
requestedResourceName?: string | null;
/**
* Properties related to the resource represented by requested_resource_name.
*/
requestedResourceProperties?: Schema$ResourceProperties;
/**
* The time at which approval was requested.
*/
requestTime?: string | null;
}
/**
* Request to approve an ApprovalRequest.
*/
export interface Schema$ApproveApprovalRequestMessage {
/**
* The expiration time of this approval.
*/
expireTime?: string | null;
}
/**
* A decision that has been made to approve access to a resource.
*/
export interface Schema$ApproveDecision {
/**
* The time at which approval was granted.
*/
approveTime?: string | null;
/**
* True when the request has been auto-approved.
*/
autoApproved?: boolean | null;
/**
* The time at which the approval expires.
*/
expireTime?: string | null;
/**
* If set, denotes the timestamp at which the approval is invalidated.
*/
invalidateTime?: string | null;
/**
* True when the request has been approved by the customer's defined policy.
*/
policyApproved?: boolean | null;
/**
* The signature for the ApprovalRequest and details on how it was signed.
*/
signatureInfo?: Schema$SignatureInfo;
}
/**
* This field contains the augmented information of the request. Requires augmented administrative access to be enabled.
*/
export interface Schema$AugmentedInfo {
/**
* For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks).
*/
command?: string | null;
}
/**
* Represents all the policies that can be set for Customer Approval.
*/
export interface Schema$CustomerApprovalApprovalPolicy {
/**
* Optional. Policy for approval based on the justification given.
*/
justificationBasedApprovalPolicy?: string | null;
}
/**
* Request to dismiss an approval request.
*/
export interface Schema$DismissApprovalRequestMessage {
}
/**
* A decision that has been made to dismiss an approval request.
*/
export interface Schema$DismissDecision {
/**
* The time at which the approval request was dismissed.
*/
dismissTime?: string | null;
/**
* This field will be true if the ApprovalRequest was implicitly dismissed due to inaction by the access approval approvers (the request is not acted on by the approvers before the exiration time).
*/
implicit?: boolean | null;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
*/
export interface Schema$Empty {
}
/**
* Represents the enrollment of a cloud resource into a specific service.
*/
export interface Schema$EnrolledService {
/**
* The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * Access Context Manager * Anthos Identity Service * AlloyDB for PostgreSQL * Apigee * Application Integration * App Hub * Artifact Registry * Anthos Service Mesh * Access Transparency * BigQuery * Certificate Authority Service * Cloud Bigtable * CCAI Assist and Knowledge * Cloud Dataflow * Cloud Dataproc * CEP Security Gateway * Compliance Evaluation Service * Cloud Firestore * Cloud Healthcare API * Chronicle * Cloud AI Companion Gateway - Titan * Google Cloud Armor * Cloud Asset Inventory * Cloud Asset Search * Cloud Deploy * Cloud DNS * Cloud Latency * Cloud Memorystore for Redis * CloudNet Control * Cloud Riptide * Cloud Tasks * Cloud Trace * Cloud Data Transfer * Cloud Composer * Integration Connectors * Contact Center AI Insights * Cloud Pub/Sub * Cloud Run * Resource Manager * Cloud Spanner * Database Center * Cloud Dataform * Cloud Data Fusion * Dataplex * Dialogflow Customer Experience Edition * Cloud DLP * Document AI * Edge Container * Edge Network * Cloud EKM * Eventarc * Firebase Data Connect * Firebase Rules * App Engine * Cloud Build * Compute Engine * Cloud Functions (2nd Gen) * Cloud Filestore * Cloud Interconnect * Cloud NetApp Volumes * Cloud Storage * Generative AI App Builder * Google Kubernetes Engine * Backup for GKE API * GKE Connect * GKE Hub * Hoverboard * Cloud HSM * Cloud Identity and Access Management * Cloud Identity-Aware Proxy * Infrastructure Manager * Identity Storage Service * Key Access Justifications * Cloud Key Management Service * Cloud Logging * Looker (Google Cloud core) * Looker Studio * Management Hub * Model Armor * Cloud Monitoring * Cloud NAT * Connectivity Hub * External passthrough Network Load Balancer * OIDC One * Organization Policy Service * Org Lifecycle * Persistent Disk * Parameter Manager * Private Services Access * Regional Internal Application Load Balancer * Storage Batch Operations * Cloud Security Command Center * Secure Source Manager * Seeker * Service Provisioning * Speaker ID * Secret Manager * Cloud SQL * Cloud Speech-to-Text * Traffic Director * Cloud Text-to-Speech * USPS Andromeda * Vertex AI * Virtual Private Cloud (VPC) * VPC Access * VPC Service Controls Troubleshooter * VPC virtnet * Cloud Workstations * Web Risk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services
*/
cloudProduct?: string | null;
/**
* The enrollment level of the service.
*/
enrollmentLevel?: string | null;
}
/**
* Request to invalidate an existing approval.
*/
export interface Schema$InvalidateApprovalRequestMessage {
}
/**
* Response to listing of ApprovalRequest objects.
*/
export interface Schema$ListApprovalRequestsResponse {
/**
* Approval request details.
*/
approvalRequests?: Schema$ApprovalRequest[];
/**
* Token to retrieve the next page of results, or empty if there are no more.
*/
nextPageToken?: string | null;
}
/**
* The properties associated with the resource of the request.
*/
export interface Schema$ResourceProperties {
/**
* Whether an approval will exclude the descendants of the resource being requested.
*/
excludesDescendants?: boolean | null;
}
/**
* Information about the digital signature of the resource.
*/
export interface Schema$SignatureInfo {
/**
* The resource name of the customer CryptoKeyVersion used for signing.
*/
customerKmsKeyVersion?: string | null;
/**
* The hashing algorithm used for signature verification. It will only be present in the case of Google managed keys.
*/
googleKeyAlgorithm?: string | null;
/**
* The public key for the Google default signing, encoded in PEM format. The signature was created using a private key which may be verified using this public key.
*/
googlePublicKeyPem?: string | null;
/**
* The ApprovalRequest that is serialized without the SignatureInfo message field. This data is used with the hashing algorithm to generate the digital signature, and it can be used for signature verification.
*/
serializedApprovalRequest?: string | null;
/**
* The digital signature.
*/
signature?: string | null;
}
export class Resource$Folders {
context: APIRequestContext;
approvalRequests: Resource$Folders$Approvalrequests;
constructor(context: APIRequestContext);
/**
* Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.folders.deleteAccessApprovalSettings({
* // Name of the AccessApprovalSettings to delete.
* name: 'folders/my-folder/accessApprovalSettings',
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
deleteAccessApprovalSettings(params: Params$Resource$Folders$Deleteaccessapprovalsettings, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
deleteAccessApprovalSettings(params?: Params$Resource$Folders$Deleteaccessapprovalsettings, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Empty>>;
deleteAccessApprovalSettings(params: Params$Resource$Folders$Deleteaccessapprovalsettings, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
deleteAccessApprovalSettings(params: Params$Resource$Folders$Deleteaccessapprovalsettings, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
deleteAccessApprovalSettings(params: Params$Resource$Folders$Deleteaccessapprovalsettings, callback: BodyResponseCallback<Schema$Empty>): void;
deleteAccessApprovalSettings(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* Gets the Access Approval settings associated with a project, folder, or organization.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.folders.getAccessApprovalSettings({
* // The name of the AccessApprovalSettings to retrieve. Format: "{projects|folders|organizations\}/{id\}/accessApprovalSettings"
* name: 'folders/my-folder/accessApprovalSettings',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "activeKeyVersion": "my_activeKeyVersion",
* // "ancestorHasActiveKeyVersion": false,
* // "approvalPolicy": {},
* // "effectiveApprovalPolicy": {},
* // "enrolledAncestor": false,
* // "enrolledServices": [],
* // "invalidKeyVersion": false,
* // "name": "my_name",
* // "notificationEmails": [],
* // "notificationPubsubTopic": "my_notificationPubsubTopic",
* // "preferNoBroadApprovalRequests": false,
* // "preferredRequestExpirationDays": 0,
* // "requestScopeMaxWidthPreference": "my_requestScopeMaxWidthPreference",
* // "requireCustomerVisibleJustification": false
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
getAccessApprovalSettings(params: Params$Resource$Folders$Getaccessapprovalsettings, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
getAccessApprovalSettings(params?: Params$Resource$Folders$Getaccessapprovalsettings, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$AccessApprovalSettings>>;
getAccessApprovalSettings(params: Params$Resource$Folders$Getaccessapprovalsettings, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getAccessApprovalSettings(params: Params$Resource$Folders$Getaccessapprovalsettings, options: MethodOptions | BodyResponseCallback<Schema$AccessApprovalSettings>, callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
getAccessApprovalSettings(params: Params$Resource$Folders$Getaccessapprovalsettings, callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
getAccessApprovalSettings(callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
/**
* Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.folders.getServiceAccount({
* // Name of the AccessApprovalServiceAccount to retrieve.
* name: 'folders/my-folder/serviceAccount',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "accountEmail": "my_accountEmail",
* // "name": "my_name"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
getServiceAccount(params: Params$Resource$Folders$Getserviceaccount, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
getServiceAccount(params?: Params$Resource$Folders$Getserviceaccount, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$AccessApprovalServiceAccount>>;
getServiceAccount(params: Params$Resource$Folders$Getserviceaccount, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getServiceAccount(params: Params$Resource$Folders$Getserviceaccount, options: MethodOptions | BodyResponseCallback<Schema$AccessApprovalServiceAccount>, callback: BodyResponseCallback<Schema$AccessApprovalServiceAccount>): void;
getServiceAccount(params: Params$Resource$Folders$Getserviceaccount, callback: BodyResponseCallback<Schema$AccessApprovalServiceAccount>): void;
getServiceAccount(callback: BodyResponseCallback<Schema$AccessApprovalServiceAccount>): void;
/**
* Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.folders.updateAccessApprovalSettings({
* // The resource name of the settings. Format is one of: * "projects/{project\}/accessApprovalSettings" * "folders/{folder\}/accessApprovalSettings" * "organizations/{organization\}/accessApprovalSettings"
* name: 'folders/my-folder/accessApprovalSettings',
* // 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.
* updateMask: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "activeKeyVersion": "my_activeKeyVersion",
* // "ancestorHasActiveKeyVersion": false,
* // "approvalPolicy": {},
* // "effectiveApprovalPolicy": {},
* // "enrolledAncestor": false,
* // "enrolledServices": [],
* // "invalidKeyVersion": false,
* // "name": "my_name",
* // "notificationEmails": [],
* // "notificationPubsubTopic": "my_notificationPubsubTopic",
* // "preferNoBroadApprovalRequests": false,
* // "preferredRequestExpirationDays": 0,
* // "requestScopeMaxWidthPreference": "my_requestScopeMaxWidthPreference",
* // "requireCustomerVisibleJustification": false
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "activeKeyVersion": "my_activeKeyVersion",
* // "ancestorHasActiveKeyVersion": false,
* // "approvalPolicy": {},
* // "effectiveApprovalPolicy": {},
* // "enrolledAncestor": false,
* // "enrolledServices": [],
* // "invalidKeyVersion": false,
* // "name": "my_name",
* // "notificationEmails": [],
* // "notificationPubsubTopic": "my_notificationPubsubTopic",
* // "preferNoBroadApprovalRequests": false,
* // "preferredRequestExpirationDays": 0,
* // "requestScopeMaxWidthPreference": "my_requestScopeMaxWidthPreference",
* // "requireCustomerVisibleJustification": false
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
updateAccessApprovalSettings(params: Params$Resource$Folders$Updateaccessapprovalsettings, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
updateAccessApprovalSettings(params?: Params$Resource$Folders$Updateaccessapprovalsettings, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$AccessApprovalSettings>>;
updateAccessApprovalSettings(params: Params$Resource$Folders$Updateaccessapprovalsettings, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
updateAccessApprovalSettings(params: Params$Resource$Folders$Updateaccessapprovalsettings, options: MethodOptions | BodyResponseCallback<Schema$AccessApprovalSettings>, callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
updateAccessApprovalSettings(params: Params$Resource$Folders$Updateaccessapprovalsettings, callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
updateAccessApprovalSettings(callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
}
export interface Params$Resource$Folders$Deleteaccessapprovalsettings extends StandardParameters {
/**
* Name of the AccessApprovalSettings to delete.
*/
name?: string;
}
export interface Params$Resource$Folders$Getaccessapprovalsettings extends StandardParameters {
/**
* The name of the AccessApprovalSettings to retrieve. Format: "{projects|folders|organizations\}/{id\}/accessApprovalSettings"
*/
name?: string;
}
export interface Params$Resource$Folders$Getserviceaccount extends StandardParameters {
/**
* Name of the AccessApprovalServiceAccount to retrieve.
*/
name?: string;
}
export interface Params$Resource$Folders$Updateaccessapprovalsettings extends StandardParameters {
/**
* The resource name of the settings. Format is one of: * "projects/{project\}/accessApprovalSettings" * "folders/{folder\}/accessApprovalSettings" * "organizations/{organization\}/accessApprovalSettings"
*/
name?: string;
/**
* 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.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AccessApprovalSettings;
}
export class Resource$Folders$Approvalrequests {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.folders.approvalRequests.approve({
* // Name of the approval request to approve.
* name: 'folders/my-folder/approvalRequests/my-approvalRequest',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "expireTime": "my_expireTime"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "approve": {},
* // "dismiss": {},
* // "name": "my_name",
* // "requestTime": "my_requestTime",
* // "requestedAugmentedInfo": {},
* // "requestedDuration": "my_requestedDuration",
* // "requestedExpiration": "my_requestedExpiration",
* // "requestedLocations": {},
* // "requestedReason": {},
* // "requestedResourceName": "my_requestedResourceName",
* // "requestedResourceProperties": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
approve(params: Params$Resource$Folders$Approvalrequests$Approve, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
approve(params?: Params$Resource$Folders$Approvalrequests$Approve, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ApprovalRequest>>;
approve(params: Params$Resource$Folders$Approvalrequests$Approve, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
approve(params: Params$Resource$Folders$Approvalrequests$Approve, options: MethodOptions | BodyResponseCallback<Schema$ApprovalRequest>, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
approve(params: Params$Resource$Folders$Approvalrequests$Approve, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
approve(callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
/**
* Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.folders.approvalRequests.dismiss({
* // Name of the ApprovalRequest to dismiss.
* name: 'folders/my-folder/approvalRequests/my-approvalRequest',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {}
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "approve": {},
* // "dismiss": {},
* // "name": "my_name",
* // "requestTime": "my_requestTime",
* // "requestedAugmentedInfo": {},
* // "requestedDuration": "my_requestedDuration",
* // "requestedExpiration": "my_requestedExpiration",
* // "requestedLocations": {},
* // "requestedReason": {},
* // "requestedResourceName": "my_requestedResourceName",
* // "requestedResourceProperties": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
dismiss(params: Params$Resource$Folders$Approvalrequests$Dismiss, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
dismiss(params?: Params$Resource$Folders$Approvalrequests$Dismiss, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ApprovalRequest>>;
dismiss(params: Params$Resource$Folders$Approvalrequests$Dismiss, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
dismiss(params: Params$Resource$Folders$Approvalrequests$Dismiss, options: MethodOptions | BodyResponseCallback<Schema$ApprovalRequest>, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
dismiss(params: Params$Resource$Folders$Approvalrequests$Dismiss, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
dismiss(callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
/**
* Gets an approval request. Returns NOT_FOUND if the request does not exist.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.folders.approvalRequests.get({
* // The name of the approval request to retrieve. Format: "{projects|folders|organizations\}/{id\}/approvalRequests/{approval_request\}"
* name: 'folders/my-folder/approvalRequests/my-approvalRequest',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "approve": {},
* // "dismiss": {},
* // "name": "my_name",
* // "requestTime": "my_requestTime",
* // "requestedAugmentedInfo": {},
* // "requestedDuration": "my_requestedDuration",
* // "requestedExpiration": "my_requestedExpiration",
* // "requestedLocations": {},
* // "requestedReason": {},
* // "requestedResourceName": "my_requestedResourceName",
* // "requestedResourceProperties": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Folders$Approvalrequests$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
get(params?: Params$Resource$Folders$Approvalrequests$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ApprovalRequest>>;
get(params: Params$Resource$Folders$Approvalrequests$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Folders$Approvalrequests$Get, options: MethodOptions | BodyResponseCallback<Schema$ApprovalRequest>, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
get(params: Params$Resource$Folders$Approvalrequests$Get, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
get(callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
/**
* Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.folders.approvalRequests.invalidate({
* // Name of the ApprovalRequest to invalidate.
* name: 'folders/my-folder/approvalRequests/my-approvalRequest',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {}
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "approve": {},
* // "dismiss": {},
* // "name": "my_name",
* // "requestTime": "my_requestTime",
* // "requestedAugmentedInfo": {},
* // "requestedDuration": "my_requestedDuration",
* // "requestedExpiration": "my_requestedExpiration",
* // "requestedLocations": {},
* // "requestedReason": {},
* // "requestedResourceName": "my_requestedResourceName",
* // "requestedResourceProperties": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
invalidate(params: Params$Resource$Folders$Approvalrequests$Invalidate, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
invalidate(params?: Params$Resource$Folders$Approvalrequests$Invalidate, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ApprovalRequest>>;
invalidate(params: Params$Resource$Folders$Approvalrequests$Invalidate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
invalidate(params: Params$Resource$Folders$Approvalrequests$Invalidate, options: MethodOptions | BodyResponseCallback<Schema$ApprovalRequest>, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
invalidate(params: Params$Resource$Folders$Approvalrequests$Invalidate, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
invalidate(callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.folders.approvalRequests.list({
* // 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.
* filter: 'placeholder-value',
* // Requested page size.
* pageSize: 'placeholder-value',
* // A token identifying the page of results to return.
* pageToken: 'placeholder-value',
* // The parent resource. This may be "projects/{project\}", "folders/{folder\}", or "organizations/{organization\}".
* parent: 'folders/my-folder',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "approvalRequests": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Folders$Approvalrequests$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
list(params?: Params$Resource$Folders$Approvalrequests$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ListApprovalRequestsResponse>>;
list(params: Params$Resource$Folders$Approvalrequests$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Folders$Approvalrequests$List, options: MethodOptions | BodyResponseCallback<Schema$ListApprovalRequestsResponse>, callback: BodyResponseCallback<Schema$ListApprovalRequestsResponse>): void;
list(params: Params$Resource$Folders$Approvalrequests$List, callback: BodyResponseCallback<Schema$ListApprovalRequestsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListApprovalRequestsResponse>): void;
}
export interface Params$Resource$Folders$Approvalrequests$Approve extends StandardParameters {
/**
* Name of the approval request to approve.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ApproveApprovalRequestMessage;
}
export interface Params$Resource$Folders$Approvalrequests$Dismiss extends StandardParameters {
/**
* Name of the ApprovalRequest to dismiss.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$DismissApprovalRequestMessage;
}
export interface Params$Resource$Folders$Approvalrequests$Get extends StandardParameters {
/**
* The name of the approval request to retrieve. Format: "{projects|folders|organizations\}/{id\}/approvalRequests/{approval_request\}"
*/
name?: string;
}
export interface Params$Resource$Folders$Approvalrequests$Invalidate extends StandardParameters {
/**
* Name of the ApprovalRequest to invalidate.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$InvalidateApprovalRequestMessage;
}
export interface Params$Resource$Folders$Approvalrequests$List extends StandardParameters {
/**
* 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.
*/
filter?: string;
/**
* Requested page size.
*/
pageSize?: number;
/**
* A token identifying the page of results to return.
*/
pageToken?: string;
/**
* The parent resource. This may be "projects/{project\}", "folders/{folder\}", or "organizations/{organization\}".
*/
parent?: string;
}
export class Resource$Organizations {
context: APIRequestContext;
approvalRequests: Resource$Organizations$Approvalrequests;
constructor(context: APIRequestContext);
/**
* Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.organizations.deleteAccessApprovalSettings({
* // Name of the AccessApprovalSettings to delete.
* name: 'organizations/my-organization/accessApprovalSettings',
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
deleteAccessApprovalSettings(params: Params$Resource$Organizations$Deleteaccessapprovalsettings, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
deleteAccessApprovalSettings(params?: Params$Resource$Organizations$Deleteaccessapprovalsettings, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Empty>>;
deleteAccessApprovalSettings(params: Params$Resource$Organizations$Deleteaccessapprovalsettings, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
deleteAccessApprovalSettings(params: Params$Resource$Organizations$Deleteaccessapprovalsettings, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
deleteAccessApprovalSettings(params: Params$Resource$Organizations$Deleteaccessapprovalsettings, callback: BodyResponseCallback<Schema$Empty>): void;
deleteAccessApprovalSettings(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* Gets the Access Approval settings associated with a project, folder, or organization.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.organizations.getAccessApprovalSettings({
* // The name of the AccessApprovalSettings to retrieve. Format: "{projects|folders|organizations\}/{id\}/accessApprovalSettings"
* name: 'organizations/my-organization/accessApprovalSettings',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "activeKeyVersion": "my_activeKeyVersion",
* // "ancestorHasActiveKeyVersion": false,
* // "approvalPolicy": {},
* // "effectiveApprovalPolicy": {},
* // "enrolledAncestor": false,
* // "enrolledServices": [],
* // "invalidKeyVersion": false,
* // "name": "my_name",
* // "notificationEmails": [],
* // "notificationPubsubTopic": "my_notificationPubsubTopic",
* // "preferNoBroadApprovalRequests": false,
* // "preferredRequestExpirationDays": 0,
* // "requestScopeMaxWidthPreference": "my_requestScopeMaxWidthPreference",
* // "requireCustomerVisibleJustification": false
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
getAccessApprovalSettings(params: Params$Resource$Organizations$Getaccessapprovalsettings, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
getAccessApprovalSettings(params?: Params$Resource$Organizations$Getaccessapprovalsettings, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$AccessApprovalSettings>>;
getAccessApprovalSettings(params: Params$Resource$Organizations$Getaccessapprovalsettings, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getAccessApprovalSettings(params: Params$Resource$Organizations$Getaccessapprovalsettings, options: MethodOptions | BodyResponseCallback<Schema$AccessApprovalSettings>, callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
getAccessApprovalSettings(params: Params$Resource$Organizations$Getaccessapprovalsettings, callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
getAccessApprovalSettings(callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
/**
* Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.organizations.getServiceAccount({
* // Name of the AccessApprovalServiceAccount to retrieve.
* name: 'organizations/my-organization/serviceAccount',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "accountEmail": "my_accountEmail",
* // "name": "my_name"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
getServiceAccount(params: Params$Resource$Organizations$Getserviceaccount, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
getServiceAccount(params?: Params$Resource$Organizations$Getserviceaccount, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$AccessApprovalServiceAccount>>;
getServiceAccount(params: Params$Resource$Organizations$Getserviceaccount, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getServiceAccount(params: Params$Resource$Organizations$Getserviceaccount, options: MethodOptions | BodyResponseCallback<Schema$AccessApprovalServiceAccount>, callback: BodyResponseCallback<Schema$AccessApprovalServiceAccount>): void;
getServiceAccount(params: Params$Resource$Organizations$Getserviceaccount, callback: BodyResponseCallback<Schema$AccessApprovalServiceAccount>): void;
getServiceAccount(callback: BodyResponseCallback<Schema$AccessApprovalServiceAccount>): void;
/**
* Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.organizations.updateAccessApprovalSettings({
* // The resource name of the settings. Format is one of: * "projects/{project\}/accessApprovalSettings" * "folders/{folder\}/accessApprovalSettings" * "organizations/{organization\}/accessApprovalSettings"
* name: 'organizations/my-organization/accessApprovalSettings',
* // 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.
* updateMask: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "activeKeyVersion": "my_activeKeyVersion",
* // "ancestorHasActiveKeyVersion": false,
* // "approvalPolicy": {},
* // "effectiveApprovalPolicy": {},
* // "enrolledAncestor": false,
* // "enrolledServices": [],
* // "invalidKeyVersion": false,
* // "name": "my_name",
* // "notificationEmails": [],
* // "notificationPubsubTopic": "my_notificationPubsubTopic",
* // "preferNoBroadApprovalRequests": false,
* // "preferredRequestExpirationDays": 0,
* // "requestScopeMaxWidthPreference": "my_requestScopeMaxWidthPreference",
* // "requireCustomerVisibleJustification": false
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "activeKeyVersion": "my_activeKeyVersion",
* // "ancestorHasActiveKeyVersion": false,
* // "approvalPolicy": {},
* // "effectiveApprovalPolicy": {},
* // "enrolledAncestor": false,
* // "enrolledServices": [],
* // "invalidKeyVersion": false,
* // "name": "my_name",
* // "notificationEmails": [],
* // "notificationPubsubTopic": "my_notificationPubsubTopic",
* // "preferNoBroadApprovalRequests": false,
* // "preferredRequestExpirationDays": 0,
* // "requestScopeMaxWidthPreference": "my_requestScopeMaxWidthPreference",
* // "requireCustomerVisibleJustification": false
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
updateAccessApprovalSettings(params: Params$Resource$Organizations$Updateaccessapprovalsettings, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
updateAccessApprovalSettings(params?: Params$Resource$Organizations$Updateaccessapprovalsettings, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$AccessApprovalSettings>>;
updateAccessApprovalSettings(params: Params$Resource$Organizations$Updateaccessapprovalsettings, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
updateAccessApprovalSettings(params: Params$Resource$Organizations$Updateaccessapprovalsettings, options: MethodOptions | BodyResponseCallback<Schema$AccessApprovalSettings>, callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
updateAccessApprovalSettings(params: Params$Resource$Organizations$Updateaccessapprovalsettings, callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
updateAccessApprovalSettings(callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
}
export interface Params$Resource$Organizations$Deleteaccessapprovalsettings extends StandardParameters {
/**
* Name of the AccessApprovalSettings to delete.
*/
name?: string;
}
export interface Params$Resource$Organizations$Getaccessapprovalsettings extends StandardParameters {
/**
* The name of the AccessApprovalSettings to retrieve. Format: "{projects|folders|organizations\}/{id\}/accessApprovalSettings"
*/
name?: string;
}
export interface Params$Resource$Organizations$Getserviceaccount extends StandardParameters {
/**
* Name of the AccessApprovalServiceAccount to retrieve.
*/
name?: string;
}
export interface Params$Resource$Organizations$Updateaccessapprovalsettings extends StandardParameters {
/**
* The resource name of the settings. Format is one of: * "projects/{project\}/accessApprovalSettings" * "folders/{folder\}/accessApprovalSettings" * "organizations/{organization\}/accessApprovalSettings"
*/
name?: string;
/**
* 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.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AccessApprovalSettings;
}
export class Resource$Organizations$Approvalrequests {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.organizations.approvalRequests.approve({
* // Name of the approval request to approve.
* name: 'organizations/my-organization/approvalRequests/my-approvalRequest',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "expireTime": "my_expireTime"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "approve": {},
* // "dismiss": {},
* // "name": "my_name",
* // "requestTime": "my_requestTime",
* // "requestedAugmentedInfo": {},
* // "requestedDuration": "my_requestedDuration",
* // "requestedExpiration": "my_requestedExpiration",
* // "requestedLocations": {},
* // "requestedReason": {},
* // "requestedResourceName": "my_requestedResourceName",
* // "requestedResourceProperties": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
approve(params: Params$Resource$Organizations$Approvalrequests$Approve, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
approve(params?: Params$Resource$Organizations$Approvalrequests$Approve, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ApprovalRequest>>;
approve(params: Params$Resource$Organizations$Approvalrequests$Approve, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
approve(params: Params$Resource$Organizations$Approvalrequests$Approve, options: MethodOptions | BodyResponseCallback<Schema$ApprovalRequest>, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
approve(params: Params$Resource$Organizations$Approvalrequests$Approve, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
approve(callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
/**
* Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.organizations.approvalRequests.dismiss({
* // Name of the ApprovalRequest to dismiss.
* name: 'organizations/my-organization/approvalRequests/my-approvalRequest',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {}
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "approve": {},
* // "dismiss": {},
* // "name": "my_name",
* // "requestTime": "my_requestTime",
* // "requestedAugmentedInfo": {},
* // "requestedDuration": "my_requestedDuration",
* // "requestedExpiration": "my_requestedExpiration",
* // "requestedLocations": {},
* // "requestedReason": {},
* // "requestedResourceName": "my_requestedResourceName",
* // "requestedResourceProperties": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
dismiss(params: Params$Resource$Organizations$Approvalrequests$Dismiss, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
dismiss(params?: Params$Resource$Organizations$Approvalrequests$Dismiss, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ApprovalRequest>>;
dismiss(params: Params$Resource$Organizations$Approvalrequests$Dismiss, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
dismiss(params: Params$Resource$Organizations$Approvalrequests$Dismiss, options: MethodOptions | BodyResponseCallback<Schema$ApprovalRequest>, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
dismiss(params: Params$Resource$Organizations$Approvalrequests$Dismiss, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
dismiss(callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
/**
* Gets an approval request. Returns NOT_FOUND if the request does not exist.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.organizations.approvalRequests.get({
* // The name of the approval request to retrieve. Format: "{projects|folders|organizations\}/{id\}/approvalRequests/{approval_request\}"
* name: 'organizations/my-organization/approvalRequests/my-approvalRequest',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "approve": {},
* // "dismiss": {},
* // "name": "my_name",
* // "requestTime": "my_requestTime",
* // "requestedAugmentedInfo": {},
* // "requestedDuration": "my_requestedDuration",
* // "requestedExpiration": "my_requestedExpiration",
* // "requestedLocations": {},
* // "requestedReason": {},
* // "requestedResourceName": "my_requestedResourceName",
* // "requestedResourceProperties": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Organizations$Approvalrequests$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
get(params?: Params$Resource$Organizations$Approvalrequests$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ApprovalRequest>>;
get(params: Params$Resource$Organizations$Approvalrequests$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Organizations$Approvalrequests$Get, options: MethodOptions | BodyResponseCallback<Schema$ApprovalRequest>, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
get(params: Params$Resource$Organizations$Approvalrequests$Get, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
get(callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
/**
* Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.organizations.approvalRequests.invalidate({
* // Name of the ApprovalRequest to invalidate.
* name: 'organizations/my-organization/approvalRequests/my-approvalRequest',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {}
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "approve": {},
* // "dismiss": {},
* // "name": "my_name",
* // "requestTime": "my_requestTime",
* // "requestedAugmentedInfo": {},
* // "requestedDuration": "my_requestedDuration",
* // "requestedExpiration": "my_requestedExpiration",
* // "requestedLocations": {},
* // "requestedReason": {},
* // "requestedResourceName": "my_requestedResourceName",
* // "requestedResourceProperties": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
invalidate(params: Params$Resource$Organizations$Approvalrequests$Invalidate, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
invalidate(params?: Params$Resource$Organizations$Approvalrequests$Invalidate, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ApprovalRequest>>;
invalidate(params: Params$Resource$Organizations$Approvalrequests$Invalidate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
invalidate(params: Params$Resource$Organizations$Approvalrequests$Invalidate, options: MethodOptions | BodyResponseCallback<Schema$ApprovalRequest>, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
invalidate(params: Params$Resource$Organizations$Approvalrequests$Invalidate, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
invalidate(callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.organizations.approvalRequests.list({
* // 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.
* filter: 'placeholder-value',
* // Requested page size.
* pageSize: 'placeholder-value',
* // A token identifying the page of results to return.
* pageToken: 'placeholder-value',
* // The parent resource. This may be "projects/{project\}", "folders/{folder\}", or "organizations/{organization\}".
* parent: 'organizations/my-organization',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "approvalRequests": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Organizations$Approvalrequests$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
list(params?: Params$Resource$Organizations$Approvalrequests$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ListApprovalRequestsResponse>>;
list(params: Params$Resource$Organizations$Approvalrequests$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Organizations$Approvalrequests$List, options: MethodOptions | BodyResponseCallback<Schema$ListApprovalRequestsResponse>, callback: BodyResponseCallback<Schema$ListApprovalRequestsResponse>): void;
list(params: Params$Resource$Organizations$Approvalrequests$List, callback: BodyResponseCallback<Schema$ListApprovalRequestsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListApprovalRequestsResponse>): void;
}
export interface Params$Resource$Organizations$Approvalrequests$Approve extends StandardParameters {
/**
* Name of the approval request to approve.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ApproveApprovalRequestMessage;
}
export interface Params$Resource$Organizations$Approvalrequests$Dismiss extends StandardParameters {
/**
* Name of the ApprovalRequest to dismiss.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$DismissApprovalRequestMessage;
}
export interface Params$Resource$Organizations$Approvalrequests$Get extends StandardParameters {
/**
* The name of the approval request to retrieve. Format: "{projects|folders|organizations\}/{id\}/approvalRequests/{approval_request\}"
*/
name?: string;
}
export interface Params$Resource$Organizations$Approvalrequests$Invalidate extends StandardParameters {
/**
* Name of the ApprovalRequest to invalidate.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$InvalidateApprovalRequestMessage;
}
export interface Params$Resource$Organizations$Approvalrequests$List extends StandardParameters {
/**
* 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.
*/
filter?: string;
/**
* Requested page size.
*/
pageSize?: number;
/**
* A token identifying the page of results to return.
*/
pageToken?: string;
/**
* The parent resource. This may be "projects/{project\}", "folders/{folder\}", or "organizations/{organization\}".
*/
parent?: string;
}
export class Resource$Projects {
context: APIRequestContext;
approvalRequests: Resource$Projects$Approvalrequests;
constructor(context: APIRequestContext);
/**
* Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.projects.deleteAccessApprovalSettings({
* // Name of the AccessApprovalSettings to delete.
* name: 'projects/my-project/accessApprovalSettings',
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
deleteAccessApprovalSettings(params: Params$Resource$Projects$Deleteaccessapprovalsettings, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
deleteAccessApprovalSettings(params?: Params$Resource$Projects$Deleteaccessapprovalsettings, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Empty>>;
deleteAccessApprovalSettings(params: Params$Resource$Projects$Deleteaccessapprovalsettings, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
deleteAccessApprovalSettings(params: Params$Resource$Projects$Deleteaccessapprovalsettings, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
deleteAccessApprovalSettings(params: Params$Resource$Projects$Deleteaccessapprovalsettings, callback: BodyResponseCallback<Schema$Empty>): void;
deleteAccessApprovalSettings(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* Gets the Access Approval settings associated with a project, folder, or organization.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.projects.getAccessApprovalSettings({
* // The name of the AccessApprovalSettings to retrieve. Format: "{projects|folders|organizations\}/{id\}/accessApprovalSettings"
* name: 'projects/my-project/accessApprovalSettings',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "activeKeyVersion": "my_activeKeyVersion",
* // "ancestorHasActiveKeyVersion": false,
* // "approvalPolicy": {},
* // "effectiveApprovalPolicy": {},
* // "enrolledAncestor": false,
* // "enrolledServices": [],
* // "invalidKeyVersion": false,
* // "name": "my_name",
* // "notificationEmails": [],
* // "notificationPubsubTopic": "my_notificationPubsubTopic",
* // "preferNoBroadApprovalRequests": false,
* // "preferredRequestExpirationDays": 0,
* // "requestScopeMaxWidthPreference": "my_requestScopeMaxWidthPreference",
* // "requireCustomerVisibleJustification": false
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
getAccessApprovalSettings(params: Params$Resource$Projects$Getaccessapprovalsettings, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
getAccessApprovalSettings(params?: Params$Resource$Projects$Getaccessapprovalsettings, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$AccessApprovalSettings>>;
getAccessApprovalSettings(params: Params$Resource$Projects$Getaccessapprovalsettings, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getAccessApprovalSettings(params: Params$Resource$Projects$Getaccessapprovalsettings, options: MethodOptions | BodyResponseCallback<Schema$AccessApprovalSettings>, callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
getAccessApprovalSettings(params: Params$Resource$Projects$Getaccessapprovalsettings, callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
getAccessApprovalSettings(callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
/**
* Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.projects.getServiceAccount({
* // Name of the AccessApprovalServiceAccount to retrieve.
* name: 'projects/my-project/serviceAccount',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "accountEmail": "my_accountEmail",
* // "name": "my_name"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
getServiceAccount(params: Params$Resource$Projects$Getserviceaccount, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
getServiceAccount(params?: Params$Resource$Projects$Getserviceaccount, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$AccessApprovalServiceAccount>>;
getServiceAccount(params: Params$Resource$Projects$Getserviceaccount, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getServiceAccount(params: Params$Resource$Projects$Getserviceaccount, options: MethodOptions | BodyResponseCallback<Schema$AccessApprovalServiceAccount>, callback: BodyResponseCallback<Schema$AccessApprovalServiceAccount>): void;
getServiceAccount(params: Params$Resource$Projects$Getserviceaccount, callback: BodyResponseCallback<Schema$AccessApprovalServiceAccount>): void;
getServiceAccount(callback: BodyResponseCallback<Schema$AccessApprovalServiceAccount>): void;
/**
* Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.projects.updateAccessApprovalSettings({
* // The resource name of the settings. Format is one of: * "projects/{project\}/accessApprovalSettings" * "folders/{folder\}/accessApprovalSettings" * "organizations/{organization\}/accessApprovalSettings"
* name: 'projects/my-project/accessApprovalSettings',
* // 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.
* updateMask: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "activeKeyVersion": "my_activeKeyVersion",
* // "ancestorHasActiveKeyVersion": false,
* // "approvalPolicy": {},
* // "effectiveApprovalPolicy": {},
* // "enrolledAncestor": false,
* // "enrolledServices": [],
* // "invalidKeyVersion": false,
* // "name": "my_name",
* // "notificationEmails": [],
* // "notificationPubsubTopic": "my_notificationPubsubTopic",
* // "preferNoBroadApprovalRequests": false,
* // "preferredRequestExpirationDays": 0,
* // "requestScopeMaxWidthPreference": "my_requestScopeMaxWidthPreference",
* // "requireCustomerVisibleJustification": false
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "activeKeyVersion": "my_activeKeyVersion",
* // "ancestorHasActiveKeyVersion": false,
* // "approvalPolicy": {},
* // "effectiveApprovalPolicy": {},
* // "enrolledAncestor": false,
* // "enrolledServices": [],
* // "invalidKeyVersion": false,
* // "name": "my_name",
* // "notificationEmails": [],
* // "notificationPubsubTopic": "my_notificationPubsubTopic",
* // "preferNoBroadApprovalRequests": false,
* // "preferredRequestExpirationDays": 0,
* // "requestScopeMaxWidthPreference": "my_requestScopeMaxWidthPreference",
* // "requireCustomerVisibleJustification": false
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
updateAccessApprovalSettings(params: Params$Resource$Projects$Updateaccessapprovalsettings, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
updateAccessApprovalSettings(params?: Params$Resource$Projects$Updateaccessapprovalsettings, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$AccessApprovalSettings>>;
updateAccessApprovalSettings(params: Params$Resource$Projects$Updateaccessapprovalsettings, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
updateAccessApprovalSettings(params: Params$Resource$Projects$Updateaccessapprovalsettings, options: MethodOptions | BodyResponseCallback<Schema$AccessApprovalSettings>, callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
updateAccessApprovalSettings(params: Params$Resource$Projects$Updateaccessapprovalsettings, callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
updateAccessApprovalSettings(callback: BodyResponseCallback<Schema$AccessApprovalSettings>): void;
}
export interface Params$Resource$Projects$Deleteaccessapprovalsettings extends StandardParameters {
/**
* Name of the AccessApprovalSettings to delete.
*/
name?: string;
}
export interface Params$Resource$Projects$Getaccessapprovalsettings extends StandardParameters {
/**
* The name of the AccessApprovalSettings to retrieve. Format: "{projects|folders|organizations\}/{id\}/accessApprovalSettings"
*/
name?: string;
}
export interface Params$Resource$Projects$Getserviceaccount extends StandardParameters {
/**
* Name of the AccessApprovalServiceAccount to retrieve.
*/
name?: string;
}
export interface Params$Resource$Projects$Updateaccessapprovalsettings extends StandardParameters {
/**
* The resource name of the settings. Format is one of: * "projects/{project\}/accessApprovalSettings" * "folders/{folder\}/accessApprovalSettings" * "organizations/{organization\}/accessApprovalSettings"
*/
name?: string;
/**
* 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.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AccessApprovalSettings;
}
export class Resource$Projects$Approvalrequests {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.projects.approvalRequests.approve({
* // Name of the approval request to approve.
* name: 'projects/my-project/approvalRequests/my-approvalRequest',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "expireTime": "my_expireTime"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "approve": {},
* // "dismiss": {},
* // "name": "my_name",
* // "requestTime": "my_requestTime",
* // "requestedAugmentedInfo": {},
* // "requestedDuration": "my_requestedDuration",
* // "requestedExpiration": "my_requestedExpiration",
* // "requestedLocations": {},
* // "requestedReason": {},
* // "requestedResourceName": "my_requestedResourceName",
* // "requestedResourceProperties": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
approve(params: Params$Resource$Projects$Approvalrequests$Approve, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
approve(params?: Params$Resource$Projects$Approvalrequests$Approve, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ApprovalRequest>>;
approve(params: Params$Resource$Projects$Approvalrequests$Approve, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
approve(params: Params$Resource$Projects$Approvalrequests$Approve, options: MethodOptions | BodyResponseCallback<Schema$ApprovalRequest>, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
approve(params: Params$Resource$Projects$Approvalrequests$Approve, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
approve(callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
/**
* Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.projects.approvalRequests.dismiss({
* // Name of the ApprovalRequest to dismiss.
* name: 'projects/my-project/approvalRequests/my-approvalRequest',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {}
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "approve": {},
* // "dismiss": {},
* // "name": "my_name",
* // "requestTime": "my_requestTime",
* // "requestedAugmentedInfo": {},
* // "requestedDuration": "my_requestedDuration",
* // "requestedExpiration": "my_requestedExpiration",
* // "requestedLocations": {},
* // "requestedReason": {},
* // "requestedResourceName": "my_requestedResourceName",
* // "requestedResourceProperties": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
dismiss(params: Params$Resource$Projects$Approvalrequests$Dismiss, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
dismiss(params?: Params$Resource$Projects$Approvalrequests$Dismiss, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ApprovalRequest>>;
dismiss(params: Params$Resource$Projects$Approvalrequests$Dismiss, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
dismiss(params: Params$Resource$Projects$Approvalrequests$Dismiss, options: MethodOptions | BodyResponseCallback<Schema$ApprovalRequest>, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
dismiss(params: Params$Resource$Projects$Approvalrequests$Dismiss, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
dismiss(callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
/**
* Gets an approval request. Returns NOT_FOUND if the request does not exist.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.projects.approvalRequests.get({
* // The name of the approval request to retrieve. Format: "{projects|folders|organizations\}/{id\}/approvalRequests/{approval_request\}"
* name: 'projects/my-project/approvalRequests/my-approvalRequest',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "approve": {},
* // "dismiss": {},
* // "name": "my_name",
* // "requestTime": "my_requestTime",
* // "requestedAugmentedInfo": {},
* // "requestedDuration": "my_requestedDuration",
* // "requestedExpiration": "my_requestedExpiration",
* // "requestedLocations": {},
* // "requestedReason": {},
* // "requestedResourceName": "my_requestedResourceName",
* // "requestedResourceProperties": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Approvalrequests$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
get(params?: Params$Resource$Projects$Approvalrequests$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ApprovalRequest>>;
get(params: Params$Resource$Projects$Approvalrequests$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Approvalrequests$Get, options: MethodOptions | BodyResponseCallback<Schema$ApprovalRequest>, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
get(params: Params$Resource$Projects$Approvalrequests$Get, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
get(callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
/**
* Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.projects.approvalRequests.invalidate({
* // Name of the ApprovalRequest to invalidate.
* name: 'projects/my-project/approvalRequests/my-approvalRequest',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {}
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "approve": {},
* // "dismiss": {},
* // "name": "my_name",
* // "requestTime": "my_requestTime",
* // "requestedAugmentedInfo": {},
* // "requestedDuration": "my_requestedDuration",
* // "requestedExpiration": "my_requestedExpiration",
* // "requestedLocations": {},
* // "requestedReason": {},
* // "requestedResourceName": "my_requestedResourceName",
* // "requestedResourceProperties": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
invalidate(params: Params$Resource$Projects$Approvalrequests$Invalidate, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
invalidate(params?: Params$Resource$Projects$Approvalrequests$Invalidate, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ApprovalRequest>>;
invalidate(params: Params$Resource$Projects$Approvalrequests$Invalidate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
invalidate(params: Params$Resource$Projects$Approvalrequests$Invalidate, options: MethodOptions | BodyResponseCallback<Schema$ApprovalRequest>, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
invalidate(params: Params$Resource$Projects$Approvalrequests$Invalidate, callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
invalidate(callback: BodyResponseCallback<Schema$ApprovalRequest>): void;
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/accessapproval.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const accessapproval = google.accessapproval('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await accessapproval.projects.approvalRequests.list({
* // 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.
* filter: 'placeholder-value',
* // Requested page size.
* pageSize: 'placeholder-value',
* // A token identifying the page of results to return.
* pageToken: 'placeholder-value',
* // The parent resource. This may be "projects/{project\}", "folders/{folder\}", or "organizations/{organization\}".
* parent: 'projects/my-project',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "approvalRequests": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Approvalrequests$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
list(params?: Params$Resource$Projects$Approvalrequests$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ListApprovalRequestsResponse>>;
list(params: Params$Resource$Projects$Approvalrequests$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Approvalrequests$List, options: MethodOptions | BodyResponseCallback<Schema$ListApprovalRequestsResponse>, callback: BodyResponseCallback<Schema$ListApprovalRequestsResponse>): void;
list(params: Params$Resource$Projects$Approvalrequests$List, callback: BodyResponseCallback<Schema$ListApprovalRequestsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListApprovalRequestsResponse>): void;
}
export interface Params$Resource$Projects$Approvalrequests$Approve extends StandardParameters {
/**
* Name of the approval request to approve.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ApproveApprovalRequestMessage;
}
export interface Params$Resource$Projects$Approvalrequests$Dismiss extends StandardParameters {
/**
* Name of the ApprovalRequest to dismiss.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$DismissApprovalRequestMessage;
}
export interface Params$Resource$Projects$Approvalrequests$Get extends StandardParameters {
/**
* The name of the approval request to retrieve. Format: "{projects|folders|organizations\}/{id\}/approvalRequests/{approval_request\}"
*/
name?: string;
}
export interface Params$Resource$Projects$Approvalrequests$Invalidate extends StandardParameters {
/**
* Name of the ApprovalRequest to invalidate.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$InvalidateApprovalRequestMessage;
}
export interface Params$Resource$Projects$Approvalrequests$List extends StandardParameters {
/**
* 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.
*/
filter?: string;
/**
* Requested page size.
*/
pageSize?: number;
/**
* A token identifying the page of results to return.
*/
pageToken?: string;
/**
* The parent resource. This may be "projects/{project\}", "folders/{folder\}", or "organizations/{organization\}".
*/
parent?: string;
}
export {};
}
