import type * as gax from 'google-gax'; import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax'; import { Transform } from 'stream'; import * as protos from '../../protos/protos'; /** * API to programmatically create, list and retrieve Identity Aware Proxy (IAP) * OAuth brands; and create, retrieve, delete and reset-secret of IAP OAuth * clients. * @class * @memberof v1 */ export declare class IdentityAwareProxyOAuthServiceClient { private _terminated; private _opts; private _providedCustomServicePath; private _gaxModule; private _gaxGrpc; private _protos; private _defaults; private _universeDomain; private _servicePath; private _log; auth: gax.GoogleAuth; descriptors: Descriptors; warn: (code: string, message: string, warnType?: string) => void; innerApiCalls: { [name: string]: Function; }; pathTemplates: { [name: string]: gax.PathTemplate; }; identityAwareProxyOAuthServiceStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of IdentityAwareProxyOAuthServiceClient. * * @param {object} [options] - The configuration object. * The options accepted by the constructor are described in detail * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance). * The common options are: * @param {object} [options.credentials] - Credentials object. * @param {string} [options.credentials.client_email] * @param {string} [options.credentials.private_key] * @param {string} [options.email] - Account email address. Required when * using a .pem or .p12 keyFilename. * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or * .p12 key downloaded from the Google Developers Console. If you provide * a path to a JSON file, the projectId option below is not necessary. * NOTE: .pem and .p12 require you to specify options.email as well. * @param {number} [options.port] - The port on which to connect to * the remote host. * @param {string} [options.projectId] - The project ID from the Google * Developer's Console, e.g. 'grape-spaceship-123'. We will also check * the environment variable GCLOUD_PROJECT for your project ID. If your * app is running in an environment which supports * {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials}, * your project ID will be detected automatically. * @param {string} [options.apiEndpoint] - The domain name of the * API remote host. * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override. * Follows the structure of {@link gapicConfig}. * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode. * For more information, please check the * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}. * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you * need to avoid loading the default gRPC version and want to use the fallback * HTTP implementation. Load only fallback version and pass it to the constructor: * ``` * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC * const client = new IdentityAwareProxyOAuthServiceClient({fallback: true}, gax); * ``` */ constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback); /** * Initialize the client. * Performs asynchronous operations (such as authentication) and prepares the client. * This function will be called automatically when any class method is called for the * first time, but if you need to initialize it before calling an actual method, * feel free to call initialize() directly. * * You can await on this method if you want to make sure the client is initialized. * * @returns {Promise} A promise that resolves to an authenticated service stub. */ initialize(): Promise<{ [name: string]: Function; }>; /** * The DNS address for this API service. * @deprecated Use the apiEndpoint method of the client instance. * @returns {string} The DNS address for this service. */ static get servicePath(): string; /** * The DNS address for this API service - same as servicePath. * @deprecated Use the apiEndpoint method of the client instance. * @returns {string} The DNS address for this service. */ static get apiEndpoint(): string; /** * The DNS address for this API service. * @returns {string} The DNS address for this service. */ get apiEndpoint(): string; get universeDomain(): string; /** * The port for this API service. * @returns {number} The default port for this service. */ static get port(): number; /** * The scopes needed to make gRPC calls for every method defined * in this service. * @returns {string[]} List of default scopes. */ static get scopes(): string[]; getProjectId(): Promise; getProjectId(callback: Callback): void; /** * Lists the existing brands for the project. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. GCP Project number/id. * In the following format: projects/{project_number/id}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.iap.v1.ListBrandsResponse|ListBrandsResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/identity_aware_proxy_o_auth_service.list_brands.js * region_tag:iap_v1_generated_IdentityAwareProxyOAuthService_ListBrands_async */ listBrands(request?: protos.google.cloud.iap.v1.IListBrandsRequest, options?: CallOptions): Promise<[ protos.google.cloud.iap.v1.IListBrandsResponse, protos.google.cloud.iap.v1.IListBrandsRequest | undefined, {} | undefined ]>; listBrands(request: protos.google.cloud.iap.v1.IListBrandsRequest, options: CallOptions, callback: Callback): void; listBrands(request: protos.google.cloud.iap.v1.IListBrandsRequest, callback: Callback): void; /** * Constructs a new OAuth brand for the project if one does not exist. * The created brand is "internal only", meaning that OAuth clients created * under it only accept requests from users who belong to the same Google * Workspace organization as the project. The brand is created in an * un-reviewed status. NOTE: The "internal only" status can be manually * changed in the Google Cloud Console. Requires that a brand does not already * exist for the project, and that the specified support email is owned by the * caller. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. GCP Project number/id under which the brand is to be created. * In the following format: projects/{project_number/id}. * @param {google.cloud.iap.v1.Brand} request.brand * Required. The brand to be created. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.iap.v1.Brand|Brand}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/identity_aware_proxy_o_auth_service.create_brand.js * region_tag:iap_v1_generated_IdentityAwareProxyOAuthService_CreateBrand_async */ createBrand(request?: protos.google.cloud.iap.v1.ICreateBrandRequest, options?: CallOptions): Promise<[ protos.google.cloud.iap.v1.IBrand, protos.google.cloud.iap.v1.ICreateBrandRequest | undefined, {} | undefined ]>; createBrand(request: protos.google.cloud.iap.v1.ICreateBrandRequest, options: CallOptions, callback: Callback): void; createBrand(request: protos.google.cloud.iap.v1.ICreateBrandRequest, callback: Callback): void; /** * Retrieves the OAuth brand of the project. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. Name of the brand to be fetched. * In the following format: projects/{project_number/id}/brands/{brand}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.iap.v1.Brand|Brand}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/identity_aware_proxy_o_auth_service.get_brand.js * region_tag:iap_v1_generated_IdentityAwareProxyOAuthService_GetBrand_async */ getBrand(request?: protos.google.cloud.iap.v1.IGetBrandRequest, options?: CallOptions): Promise<[ protos.google.cloud.iap.v1.IBrand, protos.google.cloud.iap.v1.IGetBrandRequest | undefined, {} | undefined ]>; getBrand(request: protos.google.cloud.iap.v1.IGetBrandRequest, options: CallOptions, callback: Callback): void; getBrand(request: protos.google.cloud.iap.v1.IGetBrandRequest, callback: Callback): void; /** * Creates an Identity Aware Proxy (IAP) OAuth client. The client is owned * by IAP. Requires that the brand for the project exists and that it is * set for internal-only use. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. Path to create the client in. * In the following format: * projects/{project_number/id}/brands/{brand}. * The project must belong to a G Suite account. * @param {google.cloud.iap.v1.IdentityAwareProxyClient} request.identityAwareProxyClient * Required. Identity Aware Proxy Client to be created. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.iap.v1.IdentityAwareProxyClient|IdentityAwareProxyClient}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/identity_aware_proxy_o_auth_service.create_identity_aware_proxy_client.js * region_tag:iap_v1_generated_IdentityAwareProxyOAuthService_CreateIdentityAwareProxyClient_async */ createIdentityAwareProxyClient(request?: protos.google.cloud.iap.v1.ICreateIdentityAwareProxyClientRequest, options?: CallOptions): Promise<[ protos.google.cloud.iap.v1.IIdentityAwareProxyClient, protos.google.cloud.iap.v1.ICreateIdentityAwareProxyClientRequest | undefined, {} | undefined ]>; createIdentityAwareProxyClient(request: protos.google.cloud.iap.v1.ICreateIdentityAwareProxyClientRequest, options: CallOptions, callback: Callback): void; createIdentityAwareProxyClient(request: protos.google.cloud.iap.v1.ICreateIdentityAwareProxyClientRequest, callback: Callback): void; /** * Retrieves an Identity Aware Proxy (IAP) OAuth client. * Requires that the client is owned by IAP. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. Name of the Identity Aware Proxy client to be fetched. * In the following format: * projects/{project_number/id}/brands/{brand}/identityAwareProxyClients/{client_id}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.iap.v1.IdentityAwareProxyClient|IdentityAwareProxyClient}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/identity_aware_proxy_o_auth_service.get_identity_aware_proxy_client.js * region_tag:iap_v1_generated_IdentityAwareProxyOAuthService_GetIdentityAwareProxyClient_async */ getIdentityAwareProxyClient(request?: protos.google.cloud.iap.v1.IGetIdentityAwareProxyClientRequest, options?: CallOptions): Promise<[ protos.google.cloud.iap.v1.IIdentityAwareProxyClient, protos.google.cloud.iap.v1.IGetIdentityAwareProxyClientRequest | undefined, {} | undefined ]>; getIdentityAwareProxyClient(request: protos.google.cloud.iap.v1.IGetIdentityAwareProxyClientRequest, options: CallOptions, callback: Callback): void; getIdentityAwareProxyClient(request: protos.google.cloud.iap.v1.IGetIdentityAwareProxyClientRequest, callback: Callback): void; /** * Resets an Identity Aware Proxy (IAP) OAuth client secret. Useful if the * secret was compromised. Requires that the client is owned by IAP. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. Name of the Identity Aware Proxy client to that will have its * secret reset. In the following format: * projects/{project_number/id}/brands/{brand}/identityAwareProxyClients/{client_id}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.iap.v1.IdentityAwareProxyClient|IdentityAwareProxyClient}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/identity_aware_proxy_o_auth_service.reset_identity_aware_proxy_client_secret.js * region_tag:iap_v1_generated_IdentityAwareProxyOAuthService_ResetIdentityAwareProxyClientSecret_async */ resetIdentityAwareProxyClientSecret(request?: protos.google.cloud.iap.v1.IResetIdentityAwareProxyClientSecretRequest, options?: CallOptions): Promise<[ protos.google.cloud.iap.v1.IIdentityAwareProxyClient, protos.google.cloud.iap.v1.IResetIdentityAwareProxyClientSecretRequest | undefined, {} | undefined ]>; resetIdentityAwareProxyClientSecret(request: protos.google.cloud.iap.v1.IResetIdentityAwareProxyClientSecretRequest, options: CallOptions, callback: Callback): void; resetIdentityAwareProxyClientSecret(request: protos.google.cloud.iap.v1.IResetIdentityAwareProxyClientSecretRequest, callback: Callback): void; /** * Deletes an Identity Aware Proxy (IAP) OAuth client. Useful for removing * obsolete clients, managing the number of clients in a given project, and * cleaning up after tests. Requires that the client is owned by IAP. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. Name of the Identity Aware Proxy client to be deleted. * In the following format: * projects/{project_number/id}/brands/{brand}/identityAwareProxyClients/{client_id}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/identity_aware_proxy_o_auth_service.delete_identity_aware_proxy_client.js * region_tag:iap_v1_generated_IdentityAwareProxyOAuthService_DeleteIdentityAwareProxyClient_async */ deleteIdentityAwareProxyClient(request?: protos.google.cloud.iap.v1.IDeleteIdentityAwareProxyClientRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.iap.v1.IDeleteIdentityAwareProxyClientRequest | undefined, {} | undefined ]>; deleteIdentityAwareProxyClient(request: protos.google.cloud.iap.v1.IDeleteIdentityAwareProxyClientRequest, options: CallOptions, callback: Callback): void; deleteIdentityAwareProxyClient(request: protos.google.cloud.iap.v1.IDeleteIdentityAwareProxyClientRequest, callback: Callback): void; /** * Lists the existing clients for the brand. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. Full brand path. * In the following format: projects/{project_number/id}/brands/{brand}. * @param {number} request.pageSize * The maximum number of clients to return. The service may return fewer than * this value. * If unspecified, at most 100 clients will be returned. * The maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous `ListIdentityAwareProxyClients` * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * `ListIdentityAwareProxyClients` must match the call that provided the page * token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.cloud.iap.v1.IdentityAwareProxyClient|IdentityAwareProxyClient}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listIdentityAwareProxyClientsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listIdentityAwareProxyClients(request?: protos.google.cloud.iap.v1.IListIdentityAwareProxyClientsRequest, options?: CallOptions): Promise<[ protos.google.cloud.iap.v1.IIdentityAwareProxyClient[], protos.google.cloud.iap.v1.IListIdentityAwareProxyClientsRequest | null, protos.google.cloud.iap.v1.IListIdentityAwareProxyClientsResponse ]>; listIdentityAwareProxyClients(request: protos.google.cloud.iap.v1.IListIdentityAwareProxyClientsRequest, options: CallOptions, callback: PaginationCallback): void; listIdentityAwareProxyClients(request: protos.google.cloud.iap.v1.IListIdentityAwareProxyClientsRequest, callback: PaginationCallback): void; /** * Equivalent to `listIdentityAwareProxyClients`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. Full brand path. * In the following format: projects/{project_number/id}/brands/{brand}. * @param {number} request.pageSize * The maximum number of clients to return. The service may return fewer than * this value. * If unspecified, at most 100 clients will be returned. * The maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous `ListIdentityAwareProxyClients` * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * `ListIdentityAwareProxyClients` must match the call that provided the page * token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.cloud.iap.v1.IdentityAwareProxyClient|IdentityAwareProxyClient} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listIdentityAwareProxyClientsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listIdentityAwareProxyClientsStream(request?: protos.google.cloud.iap.v1.IListIdentityAwareProxyClientsRequest, options?: CallOptions): Transform; /** * Equivalent to `listIdentityAwareProxyClients`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. Full brand path. * In the following format: projects/{project_number/id}/brands/{brand}. * @param {number} request.pageSize * The maximum number of clients to return. The service may return fewer than * this value. * If unspecified, at most 100 clients will be returned. * The maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous `ListIdentityAwareProxyClients` * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * `ListIdentityAwareProxyClients` must match the call that provided the page * token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.cloud.iap.v1.IdentityAwareProxyClient|IdentityAwareProxyClient}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/identity_aware_proxy_o_auth_service.list_identity_aware_proxy_clients.js * region_tag:iap_v1_generated_IdentityAwareProxyOAuthService_ListIdentityAwareProxyClients_async */ listIdentityAwareProxyClientsAsync(request?: protos.google.cloud.iap.v1.IListIdentityAwareProxyClientsRequest, options?: CallOptions): AsyncIterable; /** * Return a fully-qualified project resource name string. * * @param {string} project * @returns {string} Resource name string. */ projectPath(project: string): string; /** * Parse the project from Project resource. * * @param {string} projectName * A fully-qualified path representing Project resource. * @returns {string} A string representing the project. */ matchProjectFromProjectName(projectName: string): string | number; /** * Return a fully-qualified tunnelDestGroup resource name string. * * @param {string} project * @param {string} location * @param {string} dest_group * @returns {string} Resource name string. */ tunnelDestGroupPath(project: string, location: string, destGroup: string): string; /** * Parse the project from TunnelDestGroup resource. * * @param {string} tunnelDestGroupName * A fully-qualified path representing TunnelDestGroup resource. * @returns {string} A string representing the project. */ matchProjectFromTunnelDestGroupName(tunnelDestGroupName: string): string | number; /** * Parse the location from TunnelDestGroup resource. * * @param {string} tunnelDestGroupName * A fully-qualified path representing TunnelDestGroup resource. * @returns {string} A string representing the location. */ matchLocationFromTunnelDestGroupName(tunnelDestGroupName: string): string | number; /** * Parse the dest_group from TunnelDestGroup resource. * * @param {string} tunnelDestGroupName * A fully-qualified path representing TunnelDestGroup resource. * @returns {string} A string representing the dest_group. */ matchDestGroupFromTunnelDestGroupName(tunnelDestGroupName: string): string | number; /** * Return a fully-qualified tunnelLocation resource name string. * * @param {string} project * @param {string} location * @returns {string} Resource name string. */ tunnelLocationPath(project: string, location: string): string; /** * Parse the project from TunnelLocation resource. * * @param {string} tunnelLocationName * A fully-qualified path representing TunnelLocation resource. * @returns {string} A string representing the project. */ matchProjectFromTunnelLocationName(tunnelLocationName: string): string | number; /** * Parse the location from TunnelLocation resource. * * @param {string} tunnelLocationName * A fully-qualified path representing TunnelLocation resource. * @returns {string} A string representing the location. */ matchLocationFromTunnelLocationName(tunnelLocationName: string): string | number; /** * Terminate the gRPC channel and close the client. * * The client will no longer be usable and all future behavior is undefined. * @returns {Promise} A promise that resolves when the client is closed. */ close(): Promise; }