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

Version latest

• 2.6.0 (latest)
• 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 abstract class IdentityAwareProxyOAuthServiceClient

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

IdentityAwareProxyOAuthService client wrapper, for convenient use.

Inheritance

object > IdentityAwareProxyOAuthServiceClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

IdentityAwareProxyOAuthServiceClientImpl

Namespace

Google.Cloud.Iap.V1

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.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the IdentityAwareProxyOAuthService service, which is a host of "iap.googleapis.com" and a port of 443.

Property Value
Type	Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default IdentityAwareProxyOAuthService scopes.

Property Value
Type	Description
IReadOnlyListstring

Remarks

The default IdentityAwareProxyOAuthService scopes are:

• https://www.googleapis.com/auth/cloud-platform

GrpcClient

public virtual IdentityAwareProxyOAuthService.IdentityAwareProxyOAuthServiceClient GrpcClient { get; }

The underlying gRPC IdentityAwareProxyOAuthService client

Property Value
Type	Description
IdentityAwareProxyOAuthServiceIdentityAwareProxyOAuthServiceClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
ServiceMetadata

Methods

Create()

public static IdentityAwareProxyOAuthServiceClient Create()

Synchronously creates a IdentityAwareProxyOAuthServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use IdentityAwareProxyOAuthServiceClientBuilder.

Returns
Type	Description
IdentityAwareProxyOAuthServiceClient	The created IdentityAwareProxyOAuthServiceClient.

CreateAsync(CancellationToken)

public static Task<IdentityAwareProxyOAuthServiceClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a IdentityAwareProxyOAuthServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use IdentityAwareProxyOAuthServiceClientBuilder.

Parameter
Name	Description
cancellationToken	CancellationToken The CancellationToken to use while creating the client.

Returns
Type	Description
TaskIdentityAwareProxyOAuthServiceClient	The task representing the created IdentityAwareProxyOAuthServiceClient.

CreateBrand(CreateBrandRequest, CallSettings)

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

Example

// Create client
IdentityAwareProxyOAuthServiceClient identityAwareProxyOAuthServiceClient = IdentityAwareProxyOAuthServiceClient.Create();
// Initialize request argument(s)
CreateBrandRequest request = new CreateBrandRequest
{
    Parent = "",
    Brand = new Brand(),
};
// Make the request
Brand response = identityAwareProxyOAuthServiceClient.CreateBrand(request);

CreateBrandAsync(CreateBrandRequest, CallSettings)

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

Example

// Create client
IdentityAwareProxyOAuthServiceClient identityAwareProxyOAuthServiceClient = await IdentityAwareProxyOAuthServiceClient.CreateAsync();
// Initialize request argument(s)
CreateBrandRequest request = new CreateBrandRequest
{
    Parent = "",
    Brand = new Brand(),
};
// Make the request
Brand response = await identityAwareProxyOAuthServiceClient.CreateBrandAsync(request);

CreateBrandAsync(CreateBrandRequest, CancellationToken)

public virtual Task<Brand> CreateBrandAsync(CreateBrandRequest request, CancellationToken cancellationToken)

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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskBrand	A Task containing the RPC response.

Example

// Create client
IdentityAwareProxyOAuthServiceClient identityAwareProxyOAuthServiceClient = await IdentityAwareProxyOAuthServiceClient.CreateAsync();
// Initialize request argument(s)
CreateBrandRequest request = new CreateBrandRequest
{
    Parent = "",
    Brand = new Brand(),
};
// Make the request
Brand response = await identityAwareProxyOAuthServiceClient.CreateBrandAsync(request);

CreateIdentityAwareProxyClient(CreateIdentityAwareProxyClientRequest, CallSettings)

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

Example

// Create client
IdentityAwareProxyOAuthServiceClient identityAwareProxyOAuthServiceClient = IdentityAwareProxyOAuthServiceClient.Create();
// Initialize request argument(s)
CreateIdentityAwareProxyClientRequest request = new CreateIdentityAwareProxyClientRequest
{
    Parent = "",
    IdentityAwareProxyClient = new IdentityAwareProxyClient(),
};
// Make the request
IdentityAwareProxyClient response = identityAwareProxyOAuthServiceClient.CreateIdentityAwareProxyClient(request);

CreateIdentityAwareProxyClientAsync(CreateIdentityAwareProxyClientRequest, CallSettings)

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

Example

// Create client
IdentityAwareProxyOAuthServiceClient identityAwareProxyOAuthServiceClient = await IdentityAwareProxyOAuthServiceClient.CreateAsync();
// Initialize request argument(s)
CreateIdentityAwareProxyClientRequest request = new CreateIdentityAwareProxyClientRequest
{
    Parent = "",
    IdentityAwareProxyClient = new IdentityAwareProxyClient(),
};
// Make the request
IdentityAwareProxyClient response = await identityAwareProxyOAuthServiceClient.CreateIdentityAwareProxyClientAsync(request);

CreateIdentityAwareProxyClientAsync(CreateIdentityAwareProxyClientRequest, CancellationToken)

public virtual Task<IdentityAwareProxyClient> CreateIdentityAwareProxyClientAsync(CreateIdentityAwareProxyClientRequest request, CancellationToken cancellationToken)

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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskIdentityAwareProxyClient	A Task containing the RPC response.

Example

// Create client
IdentityAwareProxyOAuthServiceClient identityAwareProxyOAuthServiceClient = await IdentityAwareProxyOAuthServiceClient.CreateAsync();
// Initialize request argument(s)
CreateIdentityAwareProxyClientRequest request = new CreateIdentityAwareProxyClientRequest
{
    Parent = "",
    IdentityAwareProxyClient = new IdentityAwareProxyClient(),
};
// Make the request
IdentityAwareProxyClient response = await identityAwareProxyOAuthServiceClient.CreateIdentityAwareProxyClientAsync(request);

DeleteIdentityAwareProxyClient(DeleteIdentityAwareProxyClientRequest, CallSettings)

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

Example

// Create client
IdentityAwareProxyOAuthServiceClient identityAwareProxyOAuthServiceClient = IdentityAwareProxyOAuthServiceClient.Create();
// Initialize request argument(s)
DeleteIdentityAwareProxyClientRequest request = new DeleteIdentityAwareProxyClientRequest { Name = "", };
// Make the request
identityAwareProxyOAuthServiceClient.DeleteIdentityAwareProxyClient(request);

DeleteIdentityAwareProxyClientAsync(DeleteIdentityAwareProxyClientRequest, CallSettings)

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

Example

// Create client
IdentityAwareProxyOAuthServiceClient identityAwareProxyOAuthServiceClient = await IdentityAwareProxyOAuthServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteIdentityAwareProxyClientRequest request = new DeleteIdentityAwareProxyClientRequest { Name = "", };
// Make the request
await identityAwareProxyOAuthServiceClient.DeleteIdentityAwareProxyClientAsync(request);

DeleteIdentityAwareProxyClientAsync(DeleteIdentityAwareProxyClientRequest, CancellationToken)

public virtual Task DeleteIdentityAwareProxyClientAsync(DeleteIdentityAwareProxyClientRequest request, CancellationToken cancellationToken)

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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task	A Task containing the RPC response.

Example

// Create client
IdentityAwareProxyOAuthServiceClient identityAwareProxyOAuthServiceClient = await IdentityAwareProxyOAuthServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteIdentityAwareProxyClientRequest request = new DeleteIdentityAwareProxyClientRequest { Name = "", };
// Make the request
await identityAwareProxyOAuthServiceClient.DeleteIdentityAwareProxyClientAsync(request);

GetBrand(GetBrandRequest, CallSettings)

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

Example

// Create client
IdentityAwareProxyOAuthServiceClient identityAwareProxyOAuthServiceClient = IdentityAwareProxyOAuthServiceClient.Create();
// Initialize request argument(s)
GetBrandRequest request = new GetBrandRequest { Name = "", };
// Make the request
Brand response = identityAwareProxyOAuthServiceClient.GetBrand(request);

GetBrandAsync(GetBrandRequest, CallSettings)

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

Example

// Create client
IdentityAwareProxyOAuthServiceClient identityAwareProxyOAuthServiceClient = await IdentityAwareProxyOAuthServiceClient.CreateAsync();
// Initialize request argument(s)
GetBrandRequest request = new GetBrandRequest { Name = "", };
// Make the request
Brand response = await identityAwareProxyOAuthServiceClient.GetBrandAsync(request);

GetBrandAsync(GetBrandRequest, CancellationToken)

public virtual Task<Brand> GetBrandAsync(GetBrandRequest request, CancellationToken cancellationToken)

Retrieves the OAuth brand of the project.

Parameters
Name	Description
request	GetBrandRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskBrand	A Task containing the RPC response.

Example

// Create client
IdentityAwareProxyOAuthServiceClient identityAwareProxyOAuthServiceClient = await IdentityAwareProxyOAuthServiceClient.CreateAsync();
// Initialize request argument(s)
GetBrandRequest request = new GetBrandRequest { Name = "", };
// Make the request
Brand response = await identityAwareProxyOAuthServiceClient.GetBrandAsync(request);

GetIdentityAwareProxyClient(GetIdentityAwareProxyClientRequest, CallSettings)

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

Example

// Create client
IdentityAwareProxyOAuthServiceClient identityAwareProxyOAuthServiceClient = IdentityAwareProxyOAuthServiceClient.Create();
// Initialize request argument(s)
GetIdentityAwareProxyClientRequest request = new GetIdentityAwareProxyClientRequest { Name = "", };
// Make the request
IdentityAwareProxyClient response = identityAwareProxyOAuthServiceClient.GetIdentityAwareProxyClient(request);

GetIdentityAwareProxyClientAsync(GetIdentityAwareProxyClientRequest, CallSettings)

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

Example

// Create client
IdentityAwareProxyOAuthServiceClient identityAwareProxyOAuthServiceClient = await IdentityAwareProxyOAuthServiceClient.CreateAsync();
// Initialize request argument(s)
GetIdentityAwareProxyClientRequest request = new GetIdentityAwareProxyClientRequest { Name = "", };
// Make the request
IdentityAwareProxyClient response = await identityAwareProxyOAuthServiceClient.GetIdentityAwareProxyClientAsync(request);

GetIdentityAwareProxyClientAsync(GetIdentityAwareProxyClientRequest, CancellationToken)

public virtual Task<IdentityAwareProxyClient> GetIdentityAwareProxyClientAsync(GetIdentityAwareProxyClientRequest request, CancellationToken cancellationToken)

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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskIdentityAwareProxyClient	A Task containing the RPC response.

Example

// Create client
IdentityAwareProxyOAuthServiceClient identityAwareProxyOAuthServiceClient = await IdentityAwareProxyOAuthServiceClient.CreateAsync();
// Initialize request argument(s)
GetIdentityAwareProxyClientRequest request = new GetIdentityAwareProxyClientRequest { Name = "", };
// Make the request
IdentityAwareProxyClient response = await identityAwareProxyOAuthServiceClient.GetIdentityAwareProxyClientAsync(request);

ListBrands(ListBrandsRequest, CallSettings)

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

Example

// Create client
IdentityAwareProxyOAuthServiceClient identityAwareProxyOAuthServiceClient = IdentityAwareProxyOAuthServiceClient.Create();
// Initialize request argument(s)
ListBrandsRequest request = new ListBrandsRequest { Parent = "", };
// Make the request
ListBrandsResponse response = identityAwareProxyOAuthServiceClient.ListBrands(request);

ListBrandsAsync(ListBrandsRequest, CallSettings)

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

Example

// Create client
IdentityAwareProxyOAuthServiceClient identityAwareProxyOAuthServiceClient = await IdentityAwareProxyOAuthServiceClient.CreateAsync();
// Initialize request argument(s)
ListBrandsRequest request = new ListBrandsRequest { Parent = "", };
// Make the request
ListBrandsResponse response = await identityAwareProxyOAuthServiceClient.ListBrandsAsync(request);

ListBrandsAsync(ListBrandsRequest, CancellationToken)

public virtual Task<ListBrandsResponse> ListBrandsAsync(ListBrandsRequest request, CancellationToken cancellationToken)

Lists the existing brands for the project.

Parameters
Name	Description
request	ListBrandsRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskListBrandsResponse	A Task containing the RPC response.

Example

// Create client
IdentityAwareProxyOAuthServiceClient identityAwareProxyOAuthServiceClient = await IdentityAwareProxyOAuthServiceClient.CreateAsync();
// Initialize request argument(s)
ListBrandsRequest request = new ListBrandsRequest { Parent = "", };
// Make the request
ListBrandsResponse response = await identityAwareProxyOAuthServiceClient.ListBrandsAsync(request);

ListIdentityAwareProxyClients(ListIdentityAwareProxyClientsRequest, CallSettings)

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

Example

// Create client
IdentityAwareProxyOAuthServiceClient identityAwareProxyOAuthServiceClient = IdentityAwareProxyOAuthServiceClient.Create();
// Initialize request argument(s)
ListIdentityAwareProxyClientsRequest request = new ListIdentityAwareProxyClientsRequest { Parent = "", };
// Make the request
PagedEnumerable<ListIdentityAwareProxyClientsResponse, IdentityAwareProxyClient> response = identityAwareProxyOAuthServiceClient.ListIdentityAwareProxyClients(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (IdentityAwareProxyClient item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListIdentityAwareProxyClientsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (IdentityAwareProxyClient item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<IdentityAwareProxyClient> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (IdentityAwareProxyClient item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListIdentityAwareProxyClientsAsync(ListIdentityAwareProxyClientsRequest, CallSettings)

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

Example

// Create client
IdentityAwareProxyOAuthServiceClient identityAwareProxyOAuthServiceClient = await IdentityAwareProxyOAuthServiceClient.CreateAsync();
// Initialize request argument(s)
ListIdentityAwareProxyClientsRequest request = new ListIdentityAwareProxyClientsRequest { Parent = "", };
// Make the request
PagedAsyncEnumerable<ListIdentityAwareProxyClientsResponse, IdentityAwareProxyClient> response = identityAwareProxyOAuthServiceClient.ListIdentityAwareProxyClientsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((IdentityAwareProxyClient item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListIdentityAwareProxyClientsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (IdentityAwareProxyClient item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<IdentityAwareProxyClient> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (IdentityAwareProxyClient item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ResetIdentityAwareProxyClientSecret(ResetIdentityAwareProxyClientSecretRequest, CallSettings)

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

Example

// Create client
IdentityAwareProxyOAuthServiceClient identityAwareProxyOAuthServiceClient = IdentityAwareProxyOAuthServiceClient.Create();
// Initialize request argument(s)
ResetIdentityAwareProxyClientSecretRequest request = new ResetIdentityAwareProxyClientSecretRequest { Name = "", };
// Make the request
IdentityAwareProxyClient response = identityAwareProxyOAuthServiceClient.ResetIdentityAwareProxyClientSecret(request);

ResetIdentityAwareProxyClientSecretAsync(ResetIdentityAwareProxyClientSecretRequest, CallSettings)

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

Example

// Create client
IdentityAwareProxyOAuthServiceClient identityAwareProxyOAuthServiceClient = await IdentityAwareProxyOAuthServiceClient.CreateAsync();
// Initialize request argument(s)
ResetIdentityAwareProxyClientSecretRequest request = new ResetIdentityAwareProxyClientSecretRequest { Name = "", };
// Make the request
IdentityAwareProxyClient response = await identityAwareProxyOAuthServiceClient.ResetIdentityAwareProxyClientSecretAsync(request);

ResetIdentityAwareProxyClientSecretAsync(ResetIdentityAwareProxyClientSecretRequest, CancellationToken)

public virtual Task<IdentityAwareProxyClient> ResetIdentityAwareProxyClientSecretAsync(ResetIdentityAwareProxyClientSecretRequest request, CancellationToken cancellationToken)

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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskIdentityAwareProxyClient	A Task containing the RPC response.

Example

// Create client
IdentityAwareProxyOAuthServiceClient identityAwareProxyOAuthServiceClient = await IdentityAwareProxyOAuthServiceClient.CreateAsync();
// Initialize request argument(s)
ResetIdentityAwareProxyClientSecretRequest request = new ResetIdentityAwareProxyClientSecretRequest { Name = "", };
// Make the request
IdentityAwareProxyClient response = await identityAwareProxyOAuthServiceClient.ResetIdentityAwareProxyClientSecretAsync(request);

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type	Description
Task	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.