Class IdentityAwareProxyOAuthServiceGrpc.IdentityAwareProxyOAuthServiceFutureStub (0.3.0)

public static final class IdentityAwareProxyOAuthServiceGrpc.IdentityAwareProxyOAuthServiceFutureStub extends AbstractFutureStub<IdentityAwareProxyOAuthServiceGrpc.IdentityAwareProxyOAuthServiceFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service IdentityAwareProxyOAuthService.

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

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > IdentityAwareProxyOAuthServiceGrpc.IdentityAwareProxyOAuthServiceFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected IdentityAwareProxyOAuthServiceGrpc.IdentityAwareProxyOAuthServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
IdentityAwareProxyOAuthServiceGrpc.IdentityAwareProxyOAuthServiceFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createBrand(CreateBrandRequest request)

public ListenableFuture<Brand> createBrand(CreateBrandRequest request)

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.

Parameter
Name Description
request CreateBrandRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Brand>

createIdentityAwareProxyClient(CreateIdentityAwareProxyClientRequest request)

public ListenableFuture<IdentityAwareProxyClient> createIdentityAwareProxyClient(CreateIdentityAwareProxyClientRequest request)

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.

Parameter
Name Description
request CreateIdentityAwareProxyClientRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<IdentityAwareProxyClient>

deleteIdentityAwareProxyClient(DeleteIdentityAwareProxyClientRequest request)

public ListenableFuture<Empty> deleteIdentityAwareProxyClient(DeleteIdentityAwareProxyClientRequest request)

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.

Parameter
Name Description
request DeleteIdentityAwareProxyClientRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

getBrand(GetBrandRequest request)

public ListenableFuture<Brand> getBrand(GetBrandRequest request)

Retrieves the OAuth brand of the project.

Parameter
Name Description
request GetBrandRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Brand>

getIdentityAwareProxyClient(GetIdentityAwareProxyClientRequest request)

public ListenableFuture<IdentityAwareProxyClient> getIdentityAwareProxyClient(GetIdentityAwareProxyClientRequest request)

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

Parameter
Name Description
request GetIdentityAwareProxyClientRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<IdentityAwareProxyClient>

listBrands(ListBrandsRequest request)

public ListenableFuture<ListBrandsResponse> listBrands(ListBrandsRequest request)

Lists the existing brands for the project.

Parameter
Name Description
request ListBrandsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListBrandsResponse>

listIdentityAwareProxyClients(ListIdentityAwareProxyClientsRequest request)

public ListenableFuture<ListIdentityAwareProxyClientsResponse> listIdentityAwareProxyClients(ListIdentityAwareProxyClientsRequest request)

Lists the existing clients for the brand.

Parameter
Name Description
request ListIdentityAwareProxyClientsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListIdentityAwareProxyClientsResponse>

resetIdentityAwareProxyClientSecret(ResetIdentityAwareProxyClientSecretRequest request)

public ListenableFuture<IdentityAwareProxyClient> resetIdentityAwareProxyClientSecret(ResetIdentityAwareProxyClientSecretRequest request)

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

Parameter
Name Description
request ResetIdentityAwareProxyClientSecretRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<IdentityAwareProxyClient>