Class IdentityAwareProxyAdminServiceClient (1.1.0)

Version 1.1.0

• 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 IdentityAwareProxyAdminServiceClient

IdentityAwareProxyAdminService client wrapper, for convenient use.

Inheritance

Object > IdentityAwareProxyAdminServiceClient

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Derived Types

IdentityAwareProxyAdminServiceClientImpl

Namespace

Google.Cloud.Iap.V1

Assembly

Google.Cloud.Iap.V1.dll

Remarks

APIs for Identity-Aware Proxy Admin configurations.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the IdentityAwareProxyAdminService 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 IdentityAwareProxyAdminService scopes.

Property Value
Type	Description
IReadOnlyList<String>

Remarks

The default IdentityAwareProxyAdminService scopes are:

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

GrpcClient

public virtual IdentityAwareProxyAdminService.IdentityAwareProxyAdminServiceClient GrpcClient { get; }

The underlying gRPC IdentityAwareProxyAdminService client

Property Value
Type	Description
IdentityAwareProxyAdminService.IdentityAwareProxyAdminServiceClient

Methods

Create()

public static IdentityAwareProxyAdminServiceClient Create()

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

Returns
Type	Description
IdentityAwareProxyAdminServiceClient	The created IdentityAwareProxyAdminServiceClient.

CreateAsync(CancellationToken)

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

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

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

Returns
Type	Description
Task<IdentityAwareProxyAdminServiceClient>	The task representing the created IdentityAwareProxyAdminServiceClient.

GetIamPolicy(GetIamPolicyRequest, CallSettings)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)

Gets the access control policy for an Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

Parameters
Name	Description
request	GetIamPolicyRequest 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
Policy	The RPC response.

Example

// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = IdentityAwareProxyAdminServiceClient.Create();
// Initialize request argument(s)
GetIamPolicyRequest request = new GetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Options = new GetPolicyOptions(),
};
// Make the request
Policy response = identityAwareProxyAdminServiceClient.GetIamPolicy(request);

GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

public virtual Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)

Gets the access control policy for an Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

Parameters
Name	Description
request	GetIamPolicyRequest 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<Policy>	A Task containing the RPC response.

Example

// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
GetIamPolicyRequest request = new GetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Options = new GetPolicyOptions(),
};
// Make the request
Policy response = await identityAwareProxyAdminServiceClient.GetIamPolicyAsync(request);

GetIamPolicyAsync(GetIamPolicyRequest, CancellationToken)

public virtual Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CancellationToken cancellationToken)

Gets the access control policy for an Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

Parameters
Name	Description
request	GetIamPolicyRequest 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<Policy>	A Task containing the RPC response.

Example

// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
GetIamPolicyRequest request = new GetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Options = new GetPolicyOptions(),
};
// Make the request
Policy response = await identityAwareProxyAdminServiceClient.GetIamPolicyAsync(request);

GetIapSettings(GetIapSettingsRequest, CallSettings)

public virtual IapSettings GetIapSettings(GetIapSettingsRequest request, CallSettings callSettings = null)

Gets the IAP settings on a particular IAP protected resource.

Parameters
Name	Description
request	GetIapSettingsRequest 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
IapSettings	The RPC response.

Example

// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = IdentityAwareProxyAdminServiceClient.Create();
// Initialize request argument(s)
GetIapSettingsRequest request = new GetIapSettingsRequest { Name = "", };
// Make the request
IapSettings response = identityAwareProxyAdminServiceClient.GetIapSettings(request);

GetIapSettingsAsync(GetIapSettingsRequest, CallSettings)

public virtual Task<IapSettings> GetIapSettingsAsync(GetIapSettingsRequest request, CallSettings callSettings = null)

Gets the IAP settings on a particular IAP protected resource.

Parameters
Name	Description
request	GetIapSettingsRequest 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<IapSettings>	A Task containing the RPC response.

Example

// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
GetIapSettingsRequest request = new GetIapSettingsRequest { Name = "", };
// Make the request
IapSettings response = await identityAwareProxyAdminServiceClient.GetIapSettingsAsync(request);

GetIapSettingsAsync(GetIapSettingsRequest, CancellationToken)

public virtual Task<IapSettings> GetIapSettingsAsync(GetIapSettingsRequest request, CancellationToken cancellationToken)

Gets the IAP settings on a particular IAP protected resource.

Parameters
Name	Description
request	GetIapSettingsRequest 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<IapSettings>	A Task containing the RPC response.

Example

// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
GetIapSettingsRequest request = new GetIapSettingsRequest { Name = "", };
// Make the request
IapSettings response = await identityAwareProxyAdminServiceClient.GetIapSettingsAsync(request);

SetIamPolicy(SetIamPolicyRequest, CallSettings)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)

Sets the access control policy for an Identity-Aware Proxy protected resource. Replaces any existing policy. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

Parameters
Name	Description
request	SetIamPolicyRequest 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
Policy	The RPC response.

Example

// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = IdentityAwareProxyAdminServiceClient.Create();
// Initialize request argument(s)
SetIamPolicyRequest request = new SetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Policy = new Policy(),
};
// Make the request
Policy response = identityAwareProxyAdminServiceClient.SetIamPolicy(request);

SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

public virtual Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)

Sets the access control policy for an Identity-Aware Proxy protected resource. Replaces any existing policy. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

Parameters
Name	Description
request	SetIamPolicyRequest 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<Policy>	A Task containing the RPC response.

Example

// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
SetIamPolicyRequest request = new SetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Policy = new Policy(),
};
// Make the request
Policy response = await identityAwareProxyAdminServiceClient.SetIamPolicyAsync(request);

SetIamPolicyAsync(SetIamPolicyRequest, CancellationToken)

public virtual Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CancellationToken cancellationToken)

Sets the access control policy for an Identity-Aware Proxy protected resource. Replaces any existing policy. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

Parameters
Name	Description
request	SetIamPolicyRequest 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<Policy>	A Task containing the RPC response.

Example

// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
SetIamPolicyRequest request = new SetIamPolicyRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Policy = new Policy(),
};
// Make the request
Policy response = await identityAwareProxyAdminServiceClient.SetIamPolicyAsync(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.

TestIamPermissions(TestIamPermissionsRequest, CallSettings)

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

Parameters
Name	Description
request	TestIamPermissionsRequest 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
TestIamPermissionsResponse	The RPC response.

Example

// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = IdentityAwareProxyAdminServiceClient.Create();
// Initialize request argument(s)
TestIamPermissionsRequest request = new TestIamPermissionsRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Permissions = { "", },
};
// Make the request
TestIamPermissionsResponse response = identityAwareProxyAdminServiceClient.TestIamPermissions(request);

TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)

public virtual Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

Parameters
Name	Description
request	TestIamPermissionsRequest 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<TestIamPermissionsResponse>	A Task containing the RPC response.

Example

// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
TestIamPermissionsRequest request = new TestIamPermissionsRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Permissions = { "", },
};
// Make the request
TestIamPermissionsResponse response = await identityAwareProxyAdminServiceClient.TestIamPermissionsAsync(request);

TestIamPermissionsAsync(TestIamPermissionsRequest, CancellationToken)

public virtual Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CancellationToken cancellationToken)

Returns permissions that a caller has on the Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

Parameters
Name	Description
request	TestIamPermissionsRequest 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<TestIamPermissionsResponse>	A Task containing the RPC response.

Example

// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
TestIamPermissionsRequest request = new TestIamPermissionsRequest
{
    ResourceAsResourceName = new UnparsedResourceName("a/wildcard/resource"),
    Permissions = { "", },
};
// Make the request
TestIamPermissionsResponse response = await identityAwareProxyAdminServiceClient.TestIamPermissionsAsync(request);

UpdateIapSettings(UpdateIapSettingsRequest, CallSettings)

public virtual IapSettings UpdateIapSettings(UpdateIapSettingsRequest request, CallSettings callSettings = null)

Updates the IAP settings on a particular IAP protected resource. It replaces all fields unless the update_mask is set.

Parameters
Name	Description
request	UpdateIapSettingsRequest 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
IapSettings	The RPC response.

Example

// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = IdentityAwareProxyAdminServiceClient.Create();
// Initialize request argument(s)
UpdateIapSettingsRequest request = new UpdateIapSettingsRequest
{
    IapSettings = new IapSettings(),
    UpdateMask = new FieldMask(),
};
// Make the request
IapSettings response = identityAwareProxyAdminServiceClient.UpdateIapSettings(request);

UpdateIapSettingsAsync(UpdateIapSettingsRequest, CallSettings)

public virtual Task<IapSettings> UpdateIapSettingsAsync(UpdateIapSettingsRequest request, CallSettings callSettings = null)

Updates the IAP settings on a particular IAP protected resource. It replaces all fields unless the update_mask is set.

Parameters
Name	Description
request	UpdateIapSettingsRequest 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<IapSettings>	A Task containing the RPC response.

Example

// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateIapSettingsRequest request = new UpdateIapSettingsRequest
{
    IapSettings = new IapSettings(),
    UpdateMask = new FieldMask(),
};
// Make the request
IapSettings response = await identityAwareProxyAdminServiceClient.UpdateIapSettingsAsync(request);

UpdateIapSettingsAsync(UpdateIapSettingsRequest, CancellationToken)

public virtual Task<IapSettings> UpdateIapSettingsAsync(UpdateIapSettingsRequest request, CancellationToken cancellationToken)

Updates the IAP settings on a particular IAP protected resource. It replaces all fields unless the update_mask is set.

Parameters
Name	Description
request	UpdateIapSettingsRequest 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<IapSettings>	A Task containing the RPC response.

Example

// Create client
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient = await IdentityAwareProxyAdminServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateIapSettingsRequest request = new UpdateIapSettingsRequest
{
    IapSettings = new IapSettings(),
    UpdateMask = new FieldMask(),
};
// Make the request
IapSettings response = await identityAwareProxyAdminServiceClient.UpdateIapSettingsAsync(request);