Cloud Identity-Aware Proxy v1 API - Class IdentityAwareProxyOAuthServiceClientImpl (2.3.0)

Version 2.3.0

• 2.7.0 (latest)
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class IdentityAwareProxyOAuthServiceClientImpl : IdentityAwareProxyOAuthServiceClient

Reference documentation and code samples for the Cloud Identity-Aware Proxy v1 API class IdentityAwareProxyOAuthServiceClientImpl.

IdentityAwareProxyOAuthService client wrapper implementation, for convenient use.

Inheritance

object > IdentityAwareProxyOAuthServiceClient > IdentityAwareProxyOAuthServiceClientImpl

Inherited Members

IdentityAwareProxyOAuthServiceClient.DefaultEndpoint

IdentityAwareProxyOAuthServiceClient.DefaultScopes

IdentityAwareProxyOAuthServiceClient.ServiceMetadata

IdentityAwareProxyOAuthServiceClient.CreateAsync(CancellationToken)

IdentityAwareProxyOAuthServiceClient.Create()

IdentityAwareProxyOAuthServiceClient.ShutdownDefaultChannelsAsync()

IdentityAwareProxyOAuthServiceClient.ListBrandsAsync(ListBrandsRequest, CancellationToken)

IdentityAwareProxyOAuthServiceClient.CreateBrandAsync(CreateBrandRequest, CancellationToken)

IdentityAwareProxyOAuthServiceClient.GetBrandAsync(GetBrandRequest, CancellationToken)

IdentityAwareProxyOAuthServiceClient.CreateIdentityAwareProxyClientAsync(CreateIdentityAwareProxyClientRequest, CancellationToken)

IdentityAwareProxyOAuthServiceClient.GetIdentityAwareProxyClientAsync(GetIdentityAwareProxyClientRequest, CancellationToken)

IdentityAwareProxyOAuthServiceClient.ResetIdentityAwareProxyClientSecretAsync(ResetIdentityAwareProxyClientSecretRequest, CancellationToken)

IdentityAwareProxyOAuthServiceClient.DeleteIdentityAwareProxyClientAsync(DeleteIdentityAwareProxyClientRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

GoogleGoogle.CloudGoogle.Cloud.IapV1

Assembly

Google.Cloud.Iap.V1.dll

Remarks

API to programmatically create, list and retrieve Identity Aware Proxy (IAP) OAuth brands; and create, retrieve, delete and reset-secret of IAP OAuth clients.

Constructors

IdentityAwareProxyOAuthServiceClientImpl(IdentityAwareProxyOAuthServiceClient, IdentityAwareProxyOAuthServiceSettings, ILogger)

public IdentityAwareProxyOAuthServiceClientImpl(IdentityAwareProxyOAuthService.IdentityAwareProxyOAuthServiceClient grpcClient, IdentityAwareProxyOAuthServiceSettings settings, ILogger logger)

Constructs a client wrapper for the IdentityAwareProxyOAuthService service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	IdentityAwareProxyOAuthServiceIdentityAwareProxyOAuthServiceClient The underlying gRPC client.
settings	IdentityAwareProxyOAuthServiceSettings The base IdentityAwareProxyOAuthServiceSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

GrpcClient

public override IdentityAwareProxyOAuthService.IdentityAwareProxyOAuthServiceClient GrpcClient { get; }

The underlying gRPC IdentityAwareProxyOAuthService client

Property Value
Type	Description
IdentityAwareProxyOAuthServiceIdentityAwareProxyOAuthServiceClient

Overrides

IdentityAwareProxyOAuthServiceClient.GrpcClient

Methods

CreateBrand(CreateBrandRequest, CallSettings)

public override Brand CreateBrand(CreateBrandRequest request, CallSettings callSettings = null)

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.

Parameters
Name	Description
request	CreateBrandRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Brand	The RPC response.

Overrides

IdentityAwareProxyOAuthServiceClient.CreateBrand(CreateBrandRequest, CallSettings)

CreateBrandAsync(CreateBrandRequest, CallSettings)

public override Task<Brand> CreateBrandAsync(CreateBrandRequest request, CallSettings callSettings = null)

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.

Parameters
Name	Description
request	CreateBrandRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskBrand	A Task containing the RPC response.

Overrides

IdentityAwareProxyOAuthServiceClient.CreateBrandAsync(CreateBrandRequest, CallSettings)

CreateIdentityAwareProxyClient(CreateIdentityAwareProxyClientRequest, CallSettings)

public override IdentityAwareProxyClient CreateIdentityAwareProxyClient(CreateIdentityAwareProxyClientRequest request, CallSettings callSettings = null)

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.

Parameters
Name	Description
request	CreateIdentityAwareProxyClientRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
IdentityAwareProxyClient	The RPC response.

Overrides

IdentityAwareProxyOAuthServiceClient.CreateIdentityAwareProxyClient(CreateIdentityAwareProxyClientRequest, CallSettings)

CreateIdentityAwareProxyClientAsync(CreateIdentityAwareProxyClientRequest, CallSettings)

public override Task<IdentityAwareProxyClient> CreateIdentityAwareProxyClientAsync(CreateIdentityAwareProxyClientRequest request, CallSettings callSettings = null)

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.

Parameters
Name	Description
request	CreateIdentityAwareProxyClientRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskIdentityAwareProxyClient	A Task containing the RPC response.

Overrides

IdentityAwareProxyOAuthServiceClient.CreateIdentityAwareProxyClientAsync(CreateIdentityAwareProxyClientRequest, CallSettings)

DeleteIdentityAwareProxyClient(DeleteIdentityAwareProxyClientRequest, CallSettings)

public override void DeleteIdentityAwareProxyClient(DeleteIdentityAwareProxyClientRequest request, CallSettings callSettings = null)

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.

Parameters
Name	Description
request	DeleteIdentityAwareProxyClientRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Overrides

IdentityAwareProxyOAuthServiceClient.DeleteIdentityAwareProxyClient(DeleteIdentityAwareProxyClientRequest, CallSettings)

DeleteIdentityAwareProxyClientAsync(DeleteIdentityAwareProxyClientRequest, CallSettings)

public override Task DeleteIdentityAwareProxyClientAsync(DeleteIdentityAwareProxyClientRequest request, CallSettings callSettings = null)

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.

Parameters
Name	Description
request	DeleteIdentityAwareProxyClientRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Overrides

IdentityAwareProxyOAuthServiceClient.DeleteIdentityAwareProxyClientAsync(DeleteIdentityAwareProxyClientRequest, CallSettings)

GetBrand(GetBrandRequest, CallSettings)

public override Brand GetBrand(GetBrandRequest request, CallSettings callSettings = null)

Retrieves the OAuth brand of the project.

Parameters
Name	Description
request	GetBrandRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Brand	The RPC response.

Overrides

IdentityAwareProxyOAuthServiceClient.GetBrand(GetBrandRequest, CallSettings)

GetBrandAsync(GetBrandRequest, CallSettings)

public override Task<Brand> GetBrandAsync(GetBrandRequest request, CallSettings callSettings = null)

Retrieves the OAuth brand of the project.

Parameters
Name	Description
request	GetBrandRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskBrand	A Task containing the RPC response.

Overrides

IdentityAwareProxyOAuthServiceClient.GetBrandAsync(GetBrandRequest, CallSettings)

GetIdentityAwareProxyClient(GetIdentityAwareProxyClientRequest, CallSettings)

public override IdentityAwareProxyClient GetIdentityAwareProxyClient(GetIdentityAwareProxyClientRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	GetIdentityAwareProxyClientRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
IdentityAwareProxyClient	The RPC response.

Overrides

IdentityAwareProxyOAuthServiceClient.GetIdentityAwareProxyClient(GetIdentityAwareProxyClientRequest, CallSettings)

GetIdentityAwareProxyClientAsync(GetIdentityAwareProxyClientRequest, CallSettings)

public override Task<IdentityAwareProxyClient> GetIdentityAwareProxyClientAsync(GetIdentityAwareProxyClientRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	GetIdentityAwareProxyClientRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskIdentityAwareProxyClient	A Task containing the RPC response.

Overrides

IdentityAwareProxyOAuthServiceClient.GetIdentityAwareProxyClientAsync(GetIdentityAwareProxyClientRequest, CallSettings)

ListBrands(ListBrandsRequest, CallSettings)

public override ListBrandsResponse ListBrands(ListBrandsRequest request, CallSettings callSettings = null)

Lists the existing brands for the project.

Parameters
Name	Description
request	ListBrandsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ListBrandsResponse	The RPC response.

Overrides

IdentityAwareProxyOAuthServiceClient.ListBrands(ListBrandsRequest, CallSettings)

ListBrandsAsync(ListBrandsRequest, CallSettings)

public override Task<ListBrandsResponse> ListBrandsAsync(ListBrandsRequest request, CallSettings callSettings = null)

Lists the existing brands for the project.

Parameters
Name	Description
request	ListBrandsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskListBrandsResponse	A Task containing the RPC response.

Overrides

IdentityAwareProxyOAuthServiceClient.ListBrandsAsync(ListBrandsRequest, CallSettings)

ListIdentityAwareProxyClients(ListIdentityAwareProxyClientsRequest, CallSettings)

public override PagedEnumerable<ListIdentityAwareProxyClientsResponse, IdentityAwareProxyClient> ListIdentityAwareProxyClients(ListIdentityAwareProxyClientsRequest request, CallSettings callSettings = null)

Lists the existing clients for the brand.

Parameters
Name	Description
request	ListIdentityAwareProxyClientsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListIdentityAwareProxyClientsResponseIdentityAwareProxyClient	A pageable sequence of IdentityAwareProxyClient resources.

Overrides

IdentityAwareProxyOAuthServiceClient.ListIdentityAwareProxyClients(ListIdentityAwareProxyClientsRequest, CallSettings)

ListIdentityAwareProxyClientsAsync(ListIdentityAwareProxyClientsRequest, CallSettings)

public override PagedAsyncEnumerable<ListIdentityAwareProxyClientsResponse, IdentityAwareProxyClient> ListIdentityAwareProxyClientsAsync(ListIdentityAwareProxyClientsRequest request, CallSettings callSettings = null)

Lists the existing clients for the brand.

Parameters
Name	Description
request	ListIdentityAwareProxyClientsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListIdentityAwareProxyClientsResponseIdentityAwareProxyClient	A pageable asynchronous sequence of IdentityAwareProxyClient resources.

Overrides

IdentityAwareProxyOAuthServiceClient.ListIdentityAwareProxyClientsAsync(ListIdentityAwareProxyClientsRequest, CallSettings)

ResetIdentityAwareProxyClientSecret(ResetIdentityAwareProxyClientSecretRequest, CallSettings)

public override IdentityAwareProxyClient ResetIdentityAwareProxyClientSecret(ResetIdentityAwareProxyClientSecretRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ResetIdentityAwareProxyClientSecretRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
IdentityAwareProxyClient	The RPC response.

Overrides

IdentityAwareProxyOAuthServiceClient.ResetIdentityAwareProxyClientSecret(ResetIdentityAwareProxyClientSecretRequest, CallSettings)

ResetIdentityAwareProxyClientSecretAsync(ResetIdentityAwareProxyClientSecretRequest, CallSettings)

public override Task<IdentityAwareProxyClient> ResetIdentityAwareProxyClientSecretAsync(ResetIdentityAwareProxyClientSecretRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ResetIdentityAwareProxyClientSecretRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskIdentityAwareProxyClient	A Task containing the RPC response.

Overrides

IdentityAwareProxyOAuthServiceClient.ResetIdentityAwareProxyClientSecretAsync(ResetIdentityAwareProxyClientSecretRequest, CallSettings)