iap

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

Controls access to cloud applications running on Google Cloud Platform.

class iap {

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

async projectsBrandsCreate(parent: string, req: Brand): Promise<Brand>;

async projectsBrandsGet(name: string): Promise<Brand>;

async projectsBrandsIdentityAwareProxyClientsCreate(parent: string, req: IdentityAwareProxyClient): Promise<IdentityAwareProxyClient>;

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

async projectsBrandsIdentityAwareProxyClientsGet(name: string): Promise<IdentityAwareProxyClient>;

async projectsBrandsIdentityAwareProxyClientsList(parent: string, opts?: ProjectsBrandsIdentityAwareProxyClientsListOptions): Promise<ListIdentityAwareProxyClientsResponse>;

async projectsBrandsIdentityAwareProxyClientsResetSecret(name: string, req: ResetIdentityAwareProxyClientSecretRequest): Promise<IdentityAwareProxyClient>;

async projectsBrandsList(parent: string): Promise<ListBrandsResponse>;

async projectsIap_tunnelLocationsDestGroupsCreate(

parent: string,

req: TunnelDestGroup,

opts?: ProjectsIap_tunnelLocationsDestGroupsCreateOptions,

): Promise<TunnelDestGroup>;

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

async projectsIap_tunnelLocationsDestGroupsGet(name: string): Promise<TunnelDestGroup>;

async projectsIap_tunnelLocationsDestGroupsList(parent: string, opts?: ProjectsIap_tunnelLocationsDestGroupsListOptions): Promise<ListTunnelDestGroupsResponse>;

async projectsIap_tunnelLocationsDestGroupsPatch(

name: string,

req: TunnelDestGroup,

opts?: ProjectsIap_tunnelLocationsDestGroupsPatchOptions,

): Promise<TunnelDestGroup>;

async v1GetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>;

async v1GetIapSettings(name: string): Promise<IapSettings>;

async v1SetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async v1TestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async v1UpdateIapSettings(

name: string,

req: IapSettings,

opts?: V1UpdateIapSettingsOptions,

): Promise<IapSettings>;

async v1ValidateAttributeExpression(name: string, opts?: V1ValidateAttributeExpressionOptions): Promise<ValidateIapAttributeExpressionResponse>;

}

§Constructors

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

[src]

§Methods

projectsBrandsCreate(parent: string, req: Brand): Promise<Brand>

[src]

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 parent

Required. GCP Project number/id under which the brand is to be created. In the following format: projects/{project_number/id}.

projectsBrandsGet(name: string): Promise<Brand>

[src]

Retrieves the OAuth brand of the project.

@param name

Required. Name of the brand to be fetched. In the following format: projects/{project_number/id}/brands/{brand}.

projectsBrandsIdentityAwareProxyClientsCreate(parent: string, req: IdentityAwareProxyClient): Promise<IdentityAwareProxyClient>

[src]

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 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.

projectsBrandsIdentityAwareProxyClientsDelete(name: string): Promise<Empty>

[src]

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 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}.

projectsBrandsIdentityAwareProxyClientsGet(name: string): Promise<IdentityAwareProxyClient>

[src]

Retrieves an Identity Aware Proxy (IAP) OAuth client. Requires that the client is owned by IAP.

@param 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}.

projectsBrandsIdentityAwareProxyClientsList(parent: string, opts?: ProjectsBrandsIdentityAwareProxyClientsListOptions): Promise<ListIdentityAwareProxyClientsResponse>

[src]

Lists the existing clients for the brand.

@param parent

Required. Full brand path. In the following format: projects/{project_number/id}/brands/{brand}.

projectsBrandsIdentityAwareProxyClientsResetSecret(name: string, req: ResetIdentityAwareProxyClientSecretRequest): Promise<IdentityAwareProxyClient>

[src]

Resets an Identity Aware Proxy (IAP) OAuth client secret. Useful if the secret was compromised. Requires that the client is owned by IAP.

@param 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}.

projectsBrandsList(parent: string): Promise<ListBrandsResponse>

[src]

Lists the existing brands for the project.

@param parent

Required. GCP Project number/id. In the following format: projects/{project_number/id}.

projectsIap_tunnelLocationsDestGroupsCreate(parent: string, req: TunnelDestGroup, opts?: ProjectsIap_tunnelLocationsDestGroupsCreateOptions): Promise<TunnelDestGroup>

[src]

Creates a new TunnelDestGroup.

@param parent

Required. Google Cloud Project ID and location. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}.

projectsIap_tunnelLocationsDestGroupsDelete(name: string): Promise<Empty>

[src]

Deletes a TunnelDestGroup.

@param name

Required. Name of the TunnelDestGroup to delete. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}/destGroups/{dest_group}.

projectsIap_tunnelLocationsDestGroupsGet(name: string): Promise<TunnelDestGroup>

[src]

Retrieves an existing TunnelDestGroup.

@param name

Required. Name of the TunnelDestGroup to be fetched. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}/destGroups/{dest_group}.

projectsIap_tunnelLocationsDestGroupsList(parent: string, opts?: ProjectsIap_tunnelLocationsDestGroupsListOptions): Promise<ListTunnelDestGroupsResponse>

[src]

Lists the existing TunnelDestGroups. To group across all locations, use a - as the location ID. For example: /v1/projects/123/iap_tunnel/locations/-/destGroups

@param parent

Required. Google Cloud Project ID and location. In the following format: projects/{project_number/id}/iap_tunnel/locations/{location}. A - can be used for the location to group across all locations.

projectsIap_tunnelLocationsDestGroupsPatch(name: string, req: TunnelDestGroup, opts?: ProjectsIap_tunnelLocationsDestGroupsPatchOptions): Promise<TunnelDestGroup>

[src]

Updates a TunnelDestGroup.

@param name

Required. Immutable. Identifier for the TunnelDestGroup. Must be unique within the project and contain only lower case letters (a-z) and dashes (-).

v1GetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>

[src]

Gets the access control policy for an Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

v1GetIapSettings(name: string): Promise<IapSettings>

[src]

Gets the IAP settings on a particular IAP protected resource.

@param name

Required. The resource name for which to retrieve the settings. Authorization: Requires the getSettings permission for the associated resource.

v1SetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the access control policy for an Identity-Aware Proxy protected resource. Replaces any existing policy. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

v1TestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

Returns permissions that a caller has on the Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

v1UpdateIapSettings(name: string, req: IapSettings, opts?: V1UpdateIapSettingsOptions): Promise<IapSettings>

[src]

Updates the IAP settings on a particular IAP protected resource. It replaces all fields unless the update_mask is set.

@param name

Required. The resource name of the IAP protected resource.

v1ValidateAttributeExpression(name: string, opts?: V1ValidateAttributeExpressionOptions): Promise<ValidateIapAttributeExpressionResponse>

[src]

Validates that a given CEL expression conforms to IAP restrictions.

@param name

Required. The resource name of the IAP protected resource.