Cloud Identity-Aware Proxy v1 API - Class IdentityAwareProxyOAuthService.IdentityAwareProxyOAuthServiceClient (2.6.0)

public class IdentityAwareProxyOAuthService.IdentityAwareProxyOAuthServiceClient : ClientBase<IdentityAwareProxyOAuthService.IdentityAwareProxyOAuthServiceClient>

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

Client for IdentityAwareProxyOAuthService

Inheritance

object > ClientBase > ClientBaseIdentityAwareProxyOAuthServiceIdentityAwareProxyOAuthServiceClient > IdentityAwareProxyOAuthService.IdentityAwareProxyOAuthServiceClient

Namespace

Google.Cloud.Iap.V1

Assembly

Google.Cloud.Iap.V1.dll

Constructors

IdentityAwareProxyOAuthServiceClient()

protected IdentityAwareProxyOAuthServiceClient()

Protected parameterless constructor to allow creation of test doubles.

IdentityAwareProxyOAuthServiceClient(CallInvoker)

public IdentityAwareProxyOAuthServiceClient(CallInvoker callInvoker)

Creates a new client for IdentityAwareProxyOAuthService that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

IdentityAwareProxyOAuthServiceClient(ChannelBase)

public IdentityAwareProxyOAuthServiceClient(ChannelBase channel)

Creates a new client for IdentityAwareProxyOAuthService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

IdentityAwareProxyOAuthServiceClient(ClientBaseConfiguration)

protected IdentityAwareProxyOAuthServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateBrand(CreateBrandRequest, CallOptions)

public virtual Brand CreateBrand(CreateBrandRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Brand

The response received from the server.

CreateBrand(CreateBrandRequest, Metadata, DateTime?, CancellationToken)

public virtual Brand CreateBrand(CreateBrandRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Brand

The response received from the server.

CreateBrandAsync(CreateBrandRequest, CallOptions)

public virtual AsyncUnaryCall<Brand> CreateBrandAsync(CreateBrandRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallBrand

The call object.

CreateBrandAsync(CreateBrandRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Brand> CreateBrandAsync(CreateBrandRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallBrand

The call object.

CreateIdentityAwareProxyClient(CreateIdentityAwareProxyClientRequest, CallOptions)

public virtual IdentityAwareProxyClient CreateIdentityAwareProxyClient(CreateIdentityAwareProxyClientRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
IdentityAwareProxyClient

The response received from the server.

CreateIdentityAwareProxyClient(CreateIdentityAwareProxyClientRequest, Metadata, DateTime?, CancellationToken)

public virtual IdentityAwareProxyClient CreateIdentityAwareProxyClient(CreateIdentityAwareProxyClientRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
IdentityAwareProxyClient

The response received from the server.

CreateIdentityAwareProxyClientAsync(CreateIdentityAwareProxyClientRequest, CallOptions)

public virtual AsyncUnaryCall<IdentityAwareProxyClient> CreateIdentityAwareProxyClientAsync(CreateIdentityAwareProxyClientRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallIdentityAwareProxyClient

The call object.

CreateIdentityAwareProxyClientAsync(CreateIdentityAwareProxyClientRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<IdentityAwareProxyClient> CreateIdentityAwareProxyClientAsync(CreateIdentityAwareProxyClientRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallIdentityAwareProxyClient

The call object.

DeleteIdentityAwareProxyClient(DeleteIdentityAwareProxyClientRequest, CallOptions)

public virtual Empty DeleteIdentityAwareProxyClient(DeleteIdentityAwareProxyClientRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Empty

The response received from the server.

DeleteIdentityAwareProxyClient(DeleteIdentityAwareProxyClientRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteIdentityAwareProxyClient(DeleteIdentityAwareProxyClientRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Empty

The response received from the server.

DeleteIdentityAwareProxyClientAsync(DeleteIdentityAwareProxyClientRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteIdentityAwareProxyClientAsync(DeleteIdentityAwareProxyClientRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteIdentityAwareProxyClientAsync(DeleteIdentityAwareProxyClientRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteIdentityAwareProxyClientAsync(DeleteIdentityAwareProxyClientRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

GetBrand(GetBrandRequest, CallOptions)

public virtual Brand GetBrand(GetBrandRequest request, CallOptions options)

Retrieves the OAuth brand of the project.

Parameters
Name Description
request GetBrandRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Brand

The response received from the server.

GetBrand(GetBrandRequest, Metadata, DateTime?, CancellationToken)

public virtual Brand GetBrand(GetBrandRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the OAuth brand of the project.

Parameters
Name Description
request GetBrandRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Brand

The response received from the server.

GetBrandAsync(GetBrandRequest, CallOptions)

public virtual AsyncUnaryCall<Brand> GetBrandAsync(GetBrandRequest request, CallOptions options)

Retrieves the OAuth brand of the project.

Parameters
Name Description
request GetBrandRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallBrand

The call object.

GetBrandAsync(GetBrandRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Brand> GetBrandAsync(GetBrandRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the OAuth brand of the project.

Parameters
Name Description
request GetBrandRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallBrand

The call object.

GetIdentityAwareProxyClient(GetIdentityAwareProxyClientRequest, CallOptions)

public virtual IdentityAwareProxyClient GetIdentityAwareProxyClient(GetIdentityAwareProxyClientRequest request, CallOptions options)

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

Parameters
Name Description
request GetIdentityAwareProxyClientRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
IdentityAwareProxyClient

The response received from the server.

GetIdentityAwareProxyClient(GetIdentityAwareProxyClientRequest, Metadata, DateTime?, CancellationToken)

public virtual IdentityAwareProxyClient GetIdentityAwareProxyClient(GetIdentityAwareProxyClientRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request GetIdentityAwareProxyClientRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
IdentityAwareProxyClient

The response received from the server.

GetIdentityAwareProxyClientAsync(GetIdentityAwareProxyClientRequest, CallOptions)

public virtual AsyncUnaryCall<IdentityAwareProxyClient> GetIdentityAwareProxyClientAsync(GetIdentityAwareProxyClientRequest request, CallOptions options)

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

Parameters
Name Description
request GetIdentityAwareProxyClientRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallIdentityAwareProxyClient

The call object.

GetIdentityAwareProxyClientAsync(GetIdentityAwareProxyClientRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<IdentityAwareProxyClient> GetIdentityAwareProxyClientAsync(GetIdentityAwareProxyClientRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request GetIdentityAwareProxyClientRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallIdentityAwareProxyClient

The call object.

ListBrands(ListBrandsRequest, CallOptions)

public virtual ListBrandsResponse ListBrands(ListBrandsRequest request, CallOptions options)

Lists the existing brands for the project.

Parameters
Name Description
request ListBrandsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListBrandsResponse

The response received from the server.

ListBrands(ListBrandsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListBrandsResponse ListBrands(ListBrandsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the existing brands for the project.

Parameters
Name Description
request ListBrandsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListBrandsResponse

The response received from the server.

ListBrandsAsync(ListBrandsRequest, CallOptions)

public virtual AsyncUnaryCall<ListBrandsResponse> ListBrandsAsync(ListBrandsRequest request, CallOptions options)

Lists the existing brands for the project.

Parameters
Name Description
request ListBrandsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListBrandsResponse

The call object.

ListBrandsAsync(ListBrandsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListBrandsResponse> ListBrandsAsync(ListBrandsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the existing brands for the project.

Parameters
Name Description
request ListBrandsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListBrandsResponse

The call object.

ListIdentityAwareProxyClients(ListIdentityAwareProxyClientsRequest, CallOptions)

public virtual ListIdentityAwareProxyClientsResponse ListIdentityAwareProxyClients(ListIdentityAwareProxyClientsRequest request, CallOptions options)

Lists the existing clients for the brand.

Parameters
Name Description
request ListIdentityAwareProxyClientsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListIdentityAwareProxyClientsResponse

The response received from the server.

ListIdentityAwareProxyClients(ListIdentityAwareProxyClientsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListIdentityAwareProxyClientsResponse ListIdentityAwareProxyClients(ListIdentityAwareProxyClientsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the existing clients for the brand.

Parameters
Name Description
request ListIdentityAwareProxyClientsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListIdentityAwareProxyClientsResponse

The response received from the server.

ListIdentityAwareProxyClientsAsync(ListIdentityAwareProxyClientsRequest, CallOptions)

public virtual AsyncUnaryCall<ListIdentityAwareProxyClientsResponse> ListIdentityAwareProxyClientsAsync(ListIdentityAwareProxyClientsRequest request, CallOptions options)

Lists the existing clients for the brand.

Parameters
Name Description
request ListIdentityAwareProxyClientsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListIdentityAwareProxyClientsResponse

The call object.

ListIdentityAwareProxyClientsAsync(ListIdentityAwareProxyClientsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListIdentityAwareProxyClientsResponse> ListIdentityAwareProxyClientsAsync(ListIdentityAwareProxyClientsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the existing clients for the brand.

Parameters
Name Description
request ListIdentityAwareProxyClientsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListIdentityAwareProxyClientsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override IdentityAwareProxyOAuthService.IdentityAwareProxyOAuthServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
IdentityAwareProxyOAuthServiceIdentityAwareProxyOAuthServiceClient
Overrides

ResetIdentityAwareProxyClientSecret(ResetIdentityAwareProxyClientSecretRequest, CallOptions)

public virtual IdentityAwareProxyClient ResetIdentityAwareProxyClientSecret(ResetIdentityAwareProxyClientSecretRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
IdentityAwareProxyClient

The response received from the server.

ResetIdentityAwareProxyClientSecret(ResetIdentityAwareProxyClientSecretRequest, Metadata, DateTime?, CancellationToken)

public virtual IdentityAwareProxyClient ResetIdentityAwareProxyClientSecret(ResetIdentityAwareProxyClientSecretRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
IdentityAwareProxyClient

The response received from the server.

ResetIdentityAwareProxyClientSecretAsync(ResetIdentityAwareProxyClientSecretRequest, CallOptions)

public virtual AsyncUnaryCall<IdentityAwareProxyClient> ResetIdentityAwareProxyClientSecretAsync(ResetIdentityAwareProxyClientSecretRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallIdentityAwareProxyClient

The call object.

ResetIdentityAwareProxyClientSecretAsync(ResetIdentityAwareProxyClientSecretRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<IdentityAwareProxyClient> ResetIdentityAwareProxyClientSecretAsync(ResetIdentityAwareProxyClientSecretRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallIdentityAwareProxyClient

The call object.