Cloud Identity-Aware Proxy v1 API - Class IdentityAwareProxyOAuthService.IdentityAwareProxyOAuthServiceBase (2.1.0)

[BindServiceMethod(typeof(IdentityAwareProxyOAuthService), "BindService")]
public abstract class IdentityAwareProxyOAuthServiceBase

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

Base class for server-side implementations of IdentityAwareProxyOAuthService

Inheritance

Object > IdentityAwareProxyOAuthService.IdentityAwareProxyOAuthServiceBase

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Iap.V1

Assembly

Google.Cloud.Iap.V1.dll

Methods

CreateBrand(CreateBrandRequest, ServerCallContext)

public virtual Task<Brand> CreateBrand(CreateBrandRequest request, ServerCallContext context)

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 received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Brand>`	The response to send back to the client (wrapped by a task).

CreateIdentityAwareProxyClient(CreateIdentityAwareProxyClientRequest, ServerCallContext)

public virtual Task<IdentityAwareProxyClient> CreateIdentityAwareProxyClient(CreateIdentityAwareProxyClientRequest request, ServerCallContext context)

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 received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<IdentityAwareProxyClient>`	The response to send back to the client (wrapped by a task).

DeleteIdentityAwareProxyClient(DeleteIdentityAwareProxyClientRequest, ServerCallContext)

public virtual Task<Empty> DeleteIdentityAwareProxyClient(DeleteIdentityAwareProxyClientRequest request, ServerCallContext context)

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 received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Empty>`	The response to send back to the client (wrapped by a task).

GetBrand(GetBrandRequest, ServerCallContext)

public virtual Task<Brand> GetBrand(GetBrandRequest request, ServerCallContext context)

Retrieves the OAuth brand of the project.

Parameters
Name	Description
`request`	`GetBrandRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Brand>`	The response to send back to the client (wrapped by a task).

GetIdentityAwareProxyClient(GetIdentityAwareProxyClientRequest, ServerCallContext)

public virtual Task<IdentityAwareProxyClient> GetIdentityAwareProxyClient(GetIdentityAwareProxyClientRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`GetIdentityAwareProxyClientRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<IdentityAwareProxyClient>`	The response to send back to the client (wrapped by a task).

ListBrands(ListBrandsRequest, ServerCallContext)

public virtual Task<ListBrandsResponse> ListBrands(ListBrandsRequest request, ServerCallContext context)

Lists the existing brands for the project.

Parameters
Name	Description
`request`	`ListBrandsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<ListBrandsResponse>`	The response to send back to the client (wrapped by a task).

ListIdentityAwareProxyClients(ListIdentityAwareProxyClientsRequest, ServerCallContext)

public virtual Task<ListIdentityAwareProxyClientsResponse> ListIdentityAwareProxyClients(ListIdentityAwareProxyClientsRequest request, ServerCallContext context)

Lists the existing clients for the brand.

Parameters
Name	Description
`request`	`ListIdentityAwareProxyClientsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<ListIdentityAwareProxyClientsResponse>`	The response to send back to the client (wrapped by a task).

ResetIdentityAwareProxyClientSecret(ResetIdentityAwareProxyClientSecretRequest, ServerCallContext)

public virtual Task<IdentityAwareProxyClient> ResetIdentityAwareProxyClientSecret(ResetIdentityAwareProxyClientSecretRequest request, ServerCallContext context)

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 received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<IdentityAwareProxyClient>`	The response to send back to the client (wrapped by a task).