Identity and Access Management (IAM) v1 API - Class IAM.IAMClient (2.1.0)

public class IAMClient : ClientBase<IAM.IAMClient>

Reference documentation and code samples for the Identity and Access Management (IAM) v1 API class IAM.IAMClient.

Client for IAM

Inheritance

Object > ClientBase > ClientBase<IAM.IAMClient> > IAM.IAMClient

Namespace

Google.Cloud.Iam.Admin.V1

Assembly

Google.Cloud.Iam.Admin.V1.dll

Constructors

IAMClient()

protected IAMClient()

Protected parameterless constructor to allow creation of test doubles.

IAMClient(CallInvoker)

public IAMClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

IAMClient(ChannelBase)

public IAMClient(ChannelBase channel)

Creates a new client for IAM

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

IAMClient(ClientBase.ClientBaseConfiguration)

protected IAMClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

CreateRole(CreateRoleRequest, CallOptions)

public virtual Role CreateRole(CreateRoleRequest request, CallOptions options)

Creates a new custom [Role][google.iam.admin.v1.Role].

Parameters
NameDescription
requestCreateRoleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Role

The response received from the server.

CreateRole(CreateRoleRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Role CreateRole(CreateRoleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a new custom [Role][google.iam.admin.v1.Role].

Parameters
NameDescription
requestCreateRoleRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Role

The response received from the server.

CreateRoleAsync(CreateRoleRequest, CallOptions)

public virtual AsyncUnaryCall<Role> CreateRoleAsync(CreateRoleRequest request, CallOptions options)

Creates a new custom [Role][google.iam.admin.v1.Role].

Parameters
NameDescription
requestCreateRoleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Role>

The call object.

CreateRoleAsync(CreateRoleRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Role> CreateRoleAsync(CreateRoleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a new custom [Role][google.iam.admin.v1.Role].

Parameters
NameDescription
requestCreateRoleRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Role>

The call object.

CreateServiceAccount(CreateServiceAccountRequest, CallOptions)

public virtual ServiceAccount CreateServiceAccount(CreateServiceAccountRequest request, CallOptions options)

Creates a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Parameters
NameDescription
requestCreateServiceAccountRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ServiceAccount

The response received from the server.

CreateServiceAccount(CreateServiceAccountRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ServiceAccount CreateServiceAccount(CreateServiceAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Parameters
NameDescription
requestCreateServiceAccountRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ServiceAccount

The response received from the server.

CreateServiceAccountAsync(CreateServiceAccountRequest, CallOptions)

public virtual AsyncUnaryCall<ServiceAccount> CreateServiceAccountAsync(CreateServiceAccountRequest request, CallOptions options)

Creates a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Parameters
NameDescription
requestCreateServiceAccountRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ServiceAccount>

The call object.

CreateServiceAccountAsync(CreateServiceAccountRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ServiceAccount> CreateServiceAccountAsync(CreateServiceAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Parameters
NameDescription
requestCreateServiceAccountRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ServiceAccount>

The call object.

CreateServiceAccountKey(CreateServiceAccountKeyRequest, CallOptions)

public virtual ServiceAccountKey CreateServiceAccountKey(CreateServiceAccountKeyRequest request, CallOptions options)

Creates a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey].

Parameters
NameDescription
requestCreateServiceAccountKeyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ServiceAccountKey

The response received from the server.

CreateServiceAccountKey(CreateServiceAccountKeyRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ServiceAccountKey CreateServiceAccountKey(CreateServiceAccountKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey].

Parameters
NameDescription
requestCreateServiceAccountKeyRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ServiceAccountKey

The response received from the server.

CreateServiceAccountKeyAsync(CreateServiceAccountKeyRequest, CallOptions)

public virtual AsyncUnaryCall<ServiceAccountKey> CreateServiceAccountKeyAsync(CreateServiceAccountKeyRequest request, CallOptions options)

Creates a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey].

Parameters
NameDescription
requestCreateServiceAccountKeyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ServiceAccountKey>

The call object.

CreateServiceAccountKeyAsync(CreateServiceAccountKeyRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ServiceAccountKey> CreateServiceAccountKeyAsync(CreateServiceAccountKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey].

Parameters
NameDescription
requestCreateServiceAccountKeyRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ServiceAccountKey>

The call object.

DeleteRole(DeleteRoleRequest, CallOptions)

public virtual Role DeleteRole(DeleteRoleRequest request, CallOptions options)

Deletes a custom [Role][google.iam.admin.v1.Role].

When you delete a custom role, the following changes occur immediately:

  • You cannot bind a principal to the custom role in an IAM [Policy][google.iam.v1.Policy].
  • Existing bindings to the custom role are not changed, but they have no effect.
  • By default, the response from [ListRoles][google.iam.admin.v1.IAM.ListRoles] does not include the custom role.

You have 7 days to undelete the custom role. After 7 days, the following changes occur:

  • The custom role is permanently deleted and cannot be recovered.
  • If an IAM policy contains a binding to the custom role, the binding is permanently removed.
Parameters
NameDescription
requestDeleteRoleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Role

The response received from the server.

DeleteRole(DeleteRoleRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Role DeleteRole(DeleteRoleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes a custom [Role][google.iam.admin.v1.Role].

When you delete a custom role, the following changes occur immediately:

  • You cannot bind a principal to the custom role in an IAM [Policy][google.iam.v1.Policy].
  • Existing bindings to the custom role are not changed, but they have no effect.
  • By default, the response from [ListRoles][google.iam.admin.v1.IAM.ListRoles] does not include the custom role.

You have 7 days to undelete the custom role. After 7 days, the following changes occur:

  • The custom role is permanently deleted and cannot be recovered.
  • If an IAM policy contains a binding to the custom role, the binding is permanently removed.
Parameters
NameDescription
requestDeleteRoleRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Role

The response received from the server.

DeleteRoleAsync(DeleteRoleRequest, CallOptions)

public virtual AsyncUnaryCall<Role> DeleteRoleAsync(DeleteRoleRequest request, CallOptions options)

Deletes a custom [Role][google.iam.admin.v1.Role].

When you delete a custom role, the following changes occur immediately:

  • You cannot bind a principal to the custom role in an IAM [Policy][google.iam.v1.Policy].
  • Existing bindings to the custom role are not changed, but they have no effect.
  • By default, the response from [ListRoles][google.iam.admin.v1.IAM.ListRoles] does not include the custom role.

You have 7 days to undelete the custom role. After 7 days, the following changes occur:

  • The custom role is permanently deleted and cannot be recovered.
  • If an IAM policy contains a binding to the custom role, the binding is permanently removed.
Parameters
NameDescription
requestDeleteRoleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Role>

The call object.

DeleteRoleAsync(DeleteRoleRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Role> DeleteRoleAsync(DeleteRoleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes a custom [Role][google.iam.admin.v1.Role].

When you delete a custom role, the following changes occur immediately:

  • You cannot bind a principal to the custom role in an IAM [Policy][google.iam.v1.Policy].
  • Existing bindings to the custom role are not changed, but they have no effect.
  • By default, the response from [ListRoles][google.iam.admin.v1.IAM.ListRoles] does not include the custom role.

You have 7 days to undelete the custom role. After 7 days, the following changes occur:

  • The custom role is permanently deleted and cannot be recovered.
  • If an IAM policy contains a binding to the custom role, the binding is permanently removed.
Parameters
NameDescription
requestDeleteRoleRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Role>

The call object.

DeleteServiceAccount(DeleteServiceAccountRequest, CallOptions)

public virtual Empty DeleteServiceAccount(DeleteServiceAccountRequest request, CallOptions options)

Deletes a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Warning: After you delete a service account, you might not be able to undelete it. If you know that you need to re-enable the service account in the future, use [DisableServiceAccount][google.iam.admin.v1.IAM.DisableServiceAccount] instead.

If you delete a service account, IAM permanently removes the service account 30 days later. Google Cloud cannot recover the service account after it is permanently removed, even if you file a support request.

To help avoid unplanned outages, we recommend that you disable the service account before you delete it. Use [DisableServiceAccount][google.iam.admin.v1.IAM.DisableServiceAccount] to disable the service account, then wait at least 24 hours and watch for unintended consequences. If there are no unintended consequences, you can delete the service account.

Parameters
NameDescription
requestDeleteServiceAccountRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteServiceAccount(DeleteServiceAccountRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Warning: After you delete a service account, you might not be able to undelete it. If you know that you need to re-enable the service account in the future, use [DisableServiceAccount][google.iam.admin.v1.IAM.DisableServiceAccount] instead.

If you delete a service account, IAM permanently removes the service account 30 days later. Google Cloud cannot recover the service account after it is permanently removed, even if you file a support request.

To help avoid unplanned outages, we recommend that you disable the service account before you delete it. Use [DisableServiceAccount][google.iam.admin.v1.IAM.DisableServiceAccount] to disable the service account, then wait at least 24 hours and watch for unintended consequences. If there are no unintended consequences, you can delete the service account.

Parameters
NameDescription
requestDeleteServiceAccountRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteServiceAccountAsync(DeleteServiceAccountRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteServiceAccountAsync(DeleteServiceAccountRequest request, CallOptions options)

Deletes a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Warning: After you delete a service account, you might not be able to undelete it. If you know that you need to re-enable the service account in the future, use [DisableServiceAccount][google.iam.admin.v1.IAM.DisableServiceAccount] instead.

If you delete a service account, IAM permanently removes the service account 30 days later. Google Cloud cannot recover the service account after it is permanently removed, even if you file a support request.

To help avoid unplanned outages, we recommend that you disable the service account before you delete it. Use [DisableServiceAccount][google.iam.admin.v1.IAM.DisableServiceAccount] to disable the service account, then wait at least 24 hours and watch for unintended consequences. If there are no unintended consequences, you can delete the service account.

Parameters
NameDescription
requestDeleteServiceAccountRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

DeleteServiceAccountAsync(DeleteServiceAccountRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Warning: After you delete a service account, you might not be able to undelete it. If you know that you need to re-enable the service account in the future, use [DisableServiceAccount][google.iam.admin.v1.IAM.DisableServiceAccount] instead.

If you delete a service account, IAM permanently removes the service account 30 days later. Google Cloud cannot recover the service account after it is permanently removed, even if you file a support request.

To help avoid unplanned outages, we recommend that you disable the service account before you delete it. Use [DisableServiceAccount][google.iam.admin.v1.IAM.DisableServiceAccount] to disable the service account, then wait at least 24 hours and watch for unintended consequences. If there are no unintended consequences, you can delete the service account.

Parameters
NameDescription
requestDeleteServiceAccountRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

DeleteServiceAccountKey(DeleteServiceAccountKeyRequest, CallOptions)

public virtual Empty DeleteServiceAccountKey(DeleteServiceAccountKeyRequest request, CallOptions options)

Deletes a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey]. Deleting a service account key does not revoke short-lived credentials that have been issued based on the service account key.

Parameters
NameDescription
requestDeleteServiceAccountKeyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteServiceAccountKey(DeleteServiceAccountKeyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey]. Deleting a service account key does not revoke short-lived credentials that have been issued based on the service account key.

Parameters
NameDescription
requestDeleteServiceAccountKeyRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteServiceAccountKeyAsync(DeleteServiceAccountKeyRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteServiceAccountKeyAsync(DeleteServiceAccountKeyRequest request, CallOptions options)

Deletes a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey]. Deleting a service account key does not revoke short-lived credentials that have been issued based on the service account key.

Parameters
NameDescription
requestDeleteServiceAccountKeyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

DeleteServiceAccountKeyAsync(DeleteServiceAccountKeyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey]. Deleting a service account key does not revoke short-lived credentials that have been issued based on the service account key.

Parameters
NameDescription
requestDeleteServiceAccountKeyRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

DisableServiceAccount(DisableServiceAccountRequest, CallOptions)

public virtual Empty DisableServiceAccount(DisableServiceAccountRequest request, CallOptions options)

Disables a [ServiceAccount][google.iam.admin.v1.ServiceAccount] immediately.

If an application uses the service account to authenticate, that application can no longer call Google APIs or access Google Cloud resources. Existing access tokens for the service account are rejected, and requests for new access tokens will fail.

To re-enable the service account, use [EnableServiceAccount][google.iam.admin.v1.IAM.EnableServiceAccount]. After you re-enable the service account, its existing access tokens will be accepted, and you can request new access tokens.

To help avoid unplanned outages, we recommend that you disable the service account before you delete it. Use this method to disable the service account, then wait at least 24 hours and watch for unintended consequences. If there are no unintended consequences, you can delete the service account with [DeleteServiceAccount][google.iam.admin.v1.IAM.DeleteServiceAccount].

Parameters
NameDescription
requestDisableServiceAccountRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DisableServiceAccount(DisableServiceAccountRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Disables a [ServiceAccount][google.iam.admin.v1.ServiceAccount] immediately.

If an application uses the service account to authenticate, that application can no longer call Google APIs or access Google Cloud resources. Existing access tokens for the service account are rejected, and requests for new access tokens will fail.

To re-enable the service account, use [EnableServiceAccount][google.iam.admin.v1.IAM.EnableServiceAccount]. After you re-enable the service account, its existing access tokens will be accepted, and you can request new access tokens.

To help avoid unplanned outages, we recommend that you disable the service account before you delete it. Use this method to disable the service account, then wait at least 24 hours and watch for unintended consequences. If there are no unintended consequences, you can delete the service account with [DeleteServiceAccount][google.iam.admin.v1.IAM.DeleteServiceAccount].

Parameters
NameDescription
requestDisableServiceAccountRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Empty

The response received from the server.

DisableServiceAccountAsync(DisableServiceAccountRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DisableServiceAccountAsync(DisableServiceAccountRequest request, CallOptions options)

Disables a [ServiceAccount][google.iam.admin.v1.ServiceAccount] immediately.

If an application uses the service account to authenticate, that application can no longer call Google APIs or access Google Cloud resources. Existing access tokens for the service account are rejected, and requests for new access tokens will fail.

To re-enable the service account, use [EnableServiceAccount][google.iam.admin.v1.IAM.EnableServiceAccount]. After you re-enable the service account, its existing access tokens will be accepted, and you can request new access tokens.

To help avoid unplanned outages, we recommend that you disable the service account before you delete it. Use this method to disable the service account, then wait at least 24 hours and watch for unintended consequences. If there are no unintended consequences, you can delete the service account with [DeleteServiceAccount][google.iam.admin.v1.IAM.DeleteServiceAccount].

Parameters
NameDescription
requestDisableServiceAccountRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

DisableServiceAccountAsync(DisableServiceAccountRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Disables a [ServiceAccount][google.iam.admin.v1.ServiceAccount] immediately.

If an application uses the service account to authenticate, that application can no longer call Google APIs or access Google Cloud resources. Existing access tokens for the service account are rejected, and requests for new access tokens will fail.

To re-enable the service account, use [EnableServiceAccount][google.iam.admin.v1.IAM.EnableServiceAccount]. After you re-enable the service account, its existing access tokens will be accepted, and you can request new access tokens.

To help avoid unplanned outages, we recommend that you disable the service account before you delete it. Use this method to disable the service account, then wait at least 24 hours and watch for unintended consequences. If there are no unintended consequences, you can delete the service account with [DeleteServiceAccount][google.iam.admin.v1.IAM.DeleteServiceAccount].

Parameters
NameDescription
requestDisableServiceAccountRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

DisableServiceAccountKey(DisableServiceAccountKeyRequest, CallOptions)

public virtual Empty DisableServiceAccountKey(DisableServiceAccountKeyRequest request, CallOptions options)

Disable a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey]. A disabled service account key can be re-enabled with [EnableServiceAccountKey][google.iam.admin.v1.IAM.EnableServiceAccountKey].

Parameters
NameDescription
requestDisableServiceAccountKeyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DisableServiceAccountKey(DisableServiceAccountKeyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Disable a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey]. A disabled service account key can be re-enabled with [EnableServiceAccountKey][google.iam.admin.v1.IAM.EnableServiceAccountKey].

Parameters
NameDescription
requestDisableServiceAccountKeyRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Empty

The response received from the server.

DisableServiceAccountKeyAsync(DisableServiceAccountKeyRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DisableServiceAccountKeyAsync(DisableServiceAccountKeyRequest request, CallOptions options)

Disable a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey]. A disabled service account key can be re-enabled with [EnableServiceAccountKey][google.iam.admin.v1.IAM.EnableServiceAccountKey].

Parameters
NameDescription
requestDisableServiceAccountKeyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

DisableServiceAccountKeyAsync(DisableServiceAccountKeyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Disable a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey]. A disabled service account key can be re-enabled with [EnableServiceAccountKey][google.iam.admin.v1.IAM.EnableServiceAccountKey].

Parameters
NameDescription
requestDisableServiceAccountKeyRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

EnableServiceAccount(EnableServiceAccountRequest, CallOptions)

public virtual Empty EnableServiceAccount(EnableServiceAccountRequest request, CallOptions options)

Enables a [ServiceAccount][google.iam.admin.v1.ServiceAccount] that was disabled by [DisableServiceAccount][google.iam.admin.v1.IAM.DisableServiceAccount].

If the service account is already enabled, then this method has no effect.

If the service account was disabled by other means—for example, if Google disabled the service account because it was compromised—you cannot use this method to enable the service account.

Parameters
NameDescription
requestEnableServiceAccountRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

EnableServiceAccount(EnableServiceAccountRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Enables a [ServiceAccount][google.iam.admin.v1.ServiceAccount] that was disabled by [DisableServiceAccount][google.iam.admin.v1.IAM.DisableServiceAccount].

If the service account is already enabled, then this method has no effect.

If the service account was disabled by other means—for example, if Google disabled the service account because it was compromised—you cannot use this method to enable the service account.

Parameters
NameDescription
requestEnableServiceAccountRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Empty

The response received from the server.

EnableServiceAccountAsync(EnableServiceAccountRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> EnableServiceAccountAsync(EnableServiceAccountRequest request, CallOptions options)

Enables a [ServiceAccount][google.iam.admin.v1.ServiceAccount] that was disabled by [DisableServiceAccount][google.iam.admin.v1.IAM.DisableServiceAccount].

If the service account is already enabled, then this method has no effect.

If the service account was disabled by other means—for example, if Google disabled the service account because it was compromised—you cannot use this method to enable the service account.

Parameters
NameDescription
requestEnableServiceAccountRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

EnableServiceAccountAsync(EnableServiceAccountRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Enables a [ServiceAccount][google.iam.admin.v1.ServiceAccount] that was disabled by [DisableServiceAccount][google.iam.admin.v1.IAM.DisableServiceAccount].

If the service account is already enabled, then this method has no effect.

If the service account was disabled by other means—for example, if Google disabled the service account because it was compromised—you cannot use this method to enable the service account.

Parameters
NameDescription
requestEnableServiceAccountRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

EnableServiceAccountKey(EnableServiceAccountKeyRequest, CallOptions)

public virtual Empty EnableServiceAccountKey(EnableServiceAccountKeyRequest request, CallOptions options)

Enable a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey].

Parameters
NameDescription
requestEnableServiceAccountKeyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

EnableServiceAccountKey(EnableServiceAccountKeyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Enable a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey].

Parameters
NameDescription
requestEnableServiceAccountKeyRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Empty

The response received from the server.

EnableServiceAccountKeyAsync(EnableServiceAccountKeyRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> EnableServiceAccountKeyAsync(EnableServiceAccountKeyRequest request, CallOptions options)

Enable a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey].

Parameters
NameDescription
requestEnableServiceAccountKeyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

EnableServiceAccountKeyAsync(EnableServiceAccountKeyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Enable a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey].

Parameters
NameDescription
requestEnableServiceAccountKeyRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

GetIamPolicy(GetIamPolicyRequest, CallOptions)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, CallOptions options)

Gets the IAM policy that is attached to a [ServiceAccount][google.iam.admin.v1.ServiceAccount]. This IAM policy specifies which principals have access to the service account.

This method does not tell you whether the service account has been granted any roles on other resources. To check whether a service account has role grants on a resource, use the getIamPolicy method for that resource. For example, to view the role grants for a project, call the Resource Manager API's projects.getIamPolicy method.

Parameters
NameDescription
requestGetIamPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Policy

The response received from the server.

GetIamPolicy(GetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets the IAM policy that is attached to a [ServiceAccount][google.iam.admin.v1.ServiceAccount]. This IAM policy specifies which principals have access to the service account.

This method does not tell you whether the service account has been granted any roles on other resources. To check whether a service account has role grants on a resource, use the getIamPolicy method for that resource. For example, to view the role grants for a project, call the Resource Manager API's projects.getIamPolicy method.

Parameters
NameDescription
requestGetIamPolicyRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Policy

The response received from the server.

GetIamPolicyAsync(GetIamPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallOptions options)

Gets the IAM policy that is attached to a [ServiceAccount][google.iam.admin.v1.ServiceAccount]. This IAM policy specifies which principals have access to the service account.

This method does not tell you whether the service account has been granted any roles on other resources. To check whether a service account has role grants on a resource, use the getIamPolicy method for that resource. For example, to view the role grants for a project, call the Resource Manager API's projects.getIamPolicy method.

Parameters
NameDescription
requestGetIamPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Policy>

The call object.

GetIamPolicyAsync(GetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets the IAM policy that is attached to a [ServiceAccount][google.iam.admin.v1.ServiceAccount]. This IAM policy specifies which principals have access to the service account.

This method does not tell you whether the service account has been granted any roles on other resources. To check whether a service account has role grants on a resource, use the getIamPolicy method for that resource. For example, to view the role grants for a project, call the Resource Manager API's projects.getIamPolicy method.

Parameters
NameDescription
requestGetIamPolicyRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Policy>

The call object.

GetRole(GetRoleRequest, CallOptions)

public virtual Role GetRole(GetRoleRequest request, CallOptions options)

Gets the definition of a [Role][google.iam.admin.v1.Role].

Parameters
NameDescription
requestGetRoleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Role

The response received from the server.

GetRole(GetRoleRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Role GetRole(GetRoleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets the definition of a [Role][google.iam.admin.v1.Role].

Parameters
NameDescription
requestGetRoleRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Role

The response received from the server.

GetRoleAsync(GetRoleRequest, CallOptions)

public virtual AsyncUnaryCall<Role> GetRoleAsync(GetRoleRequest request, CallOptions options)

Gets the definition of a [Role][google.iam.admin.v1.Role].

Parameters
NameDescription
requestGetRoleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Role>

The call object.

GetRoleAsync(GetRoleRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Role> GetRoleAsync(GetRoleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets the definition of a [Role][google.iam.admin.v1.Role].

Parameters
NameDescription
requestGetRoleRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Role>

The call object.

GetServiceAccount(GetServiceAccountRequest, CallOptions)

public virtual ServiceAccount GetServiceAccount(GetServiceAccountRequest request, CallOptions options)

Gets a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Parameters
NameDescription
requestGetServiceAccountRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ServiceAccount

The response received from the server.

GetServiceAccount(GetServiceAccountRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ServiceAccount GetServiceAccount(GetServiceAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Parameters
NameDescription
requestGetServiceAccountRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ServiceAccount

The response received from the server.

GetServiceAccountAsync(GetServiceAccountRequest, CallOptions)

public virtual AsyncUnaryCall<ServiceAccount> GetServiceAccountAsync(GetServiceAccountRequest request, CallOptions options)

Gets a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Parameters
NameDescription
requestGetServiceAccountRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ServiceAccount>

The call object.

GetServiceAccountAsync(GetServiceAccountRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ServiceAccount> GetServiceAccountAsync(GetServiceAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Parameters
NameDescription
requestGetServiceAccountRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ServiceAccount>

The call object.

GetServiceAccountKey(GetServiceAccountKeyRequest, CallOptions)

public virtual ServiceAccountKey GetServiceAccountKey(GetServiceAccountKeyRequest request, CallOptions options)

Gets a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey].

Parameters
NameDescription
requestGetServiceAccountKeyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ServiceAccountKey

The response received from the server.

GetServiceAccountKey(GetServiceAccountKeyRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ServiceAccountKey GetServiceAccountKey(GetServiceAccountKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey].

Parameters
NameDescription
requestGetServiceAccountKeyRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ServiceAccountKey

The response received from the server.

GetServiceAccountKeyAsync(GetServiceAccountKeyRequest, CallOptions)

public virtual AsyncUnaryCall<ServiceAccountKey> GetServiceAccountKeyAsync(GetServiceAccountKeyRequest request, CallOptions options)

Gets a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey].

Parameters
NameDescription
requestGetServiceAccountKeyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ServiceAccountKey>

The call object.

GetServiceAccountKeyAsync(GetServiceAccountKeyRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ServiceAccountKey> GetServiceAccountKeyAsync(GetServiceAccountKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey].

Parameters
NameDescription
requestGetServiceAccountKeyRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ServiceAccountKey>

The call object.

LintPolicy(LintPolicyRequest, CallOptions)

public virtual LintPolicyResponse LintPolicy(LintPolicyRequest request, CallOptions options)

Lints, or validates, an IAM policy. Currently checks the [google.iam.v1.Binding.condition][google.iam.v1.Binding.condition] field, which contains a condition expression for a role binding.

Successful calls to this method always return an HTTP 200 OK status code, even if the linter detects an issue in the IAM policy.

Parameters
NameDescription
requestLintPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
LintPolicyResponse

The response received from the server.

LintPolicy(LintPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual LintPolicyResponse LintPolicy(LintPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lints, or validates, an IAM policy. Currently checks the [google.iam.v1.Binding.condition][google.iam.v1.Binding.condition] field, which contains a condition expression for a role binding.

Successful calls to this method always return an HTTP 200 OK status code, even if the linter detects an issue in the IAM policy.

Parameters
NameDescription
requestLintPolicyRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
LintPolicyResponse

The response received from the server.

LintPolicyAsync(LintPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<LintPolicyResponse> LintPolicyAsync(LintPolicyRequest request, CallOptions options)

Lints, or validates, an IAM policy. Currently checks the [google.iam.v1.Binding.condition][google.iam.v1.Binding.condition] field, which contains a condition expression for a role binding.

Successful calls to this method always return an HTTP 200 OK status code, even if the linter detects an issue in the IAM policy.

Parameters
NameDescription
requestLintPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<LintPolicyResponse>

The call object.

LintPolicyAsync(LintPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<LintPolicyResponse> LintPolicyAsync(LintPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lints, or validates, an IAM policy. Currently checks the [google.iam.v1.Binding.condition][google.iam.v1.Binding.condition] field, which contains a condition expression for a role binding.

Successful calls to this method always return an HTTP 200 OK status code, even if the linter detects an issue in the IAM policy.

Parameters
NameDescription
requestLintPolicyRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<LintPolicyResponse>

The call object.

ListRoles(ListRolesRequest, CallOptions)

public virtual ListRolesResponse ListRoles(ListRolesRequest request, CallOptions options)

Lists every predefined [Role][google.iam.admin.v1.Role] that IAM supports, or every custom role that is defined for an organization or project.

Parameters
NameDescription
requestListRolesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListRolesResponse

The response received from the server.

ListRoles(ListRolesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListRolesResponse ListRoles(ListRolesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists every predefined [Role][google.iam.admin.v1.Role] that IAM supports, or every custom role that is defined for an organization or project.

Parameters
NameDescription
requestListRolesRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListRolesResponse

The response received from the server.

ListRolesAsync(ListRolesRequest, CallOptions)

public virtual AsyncUnaryCall<ListRolesResponse> ListRolesAsync(ListRolesRequest request, CallOptions options)

Lists every predefined [Role][google.iam.admin.v1.Role] that IAM supports, or every custom role that is defined for an organization or project.

Parameters
NameDescription
requestListRolesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListRolesResponse>

The call object.

ListRolesAsync(ListRolesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListRolesResponse> ListRolesAsync(ListRolesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists every predefined [Role][google.iam.admin.v1.Role] that IAM supports, or every custom role that is defined for an organization or project.

Parameters
NameDescription
requestListRolesRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListRolesResponse>

The call object.

ListServiceAccountKeys(ListServiceAccountKeysRequest, CallOptions)

public virtual ListServiceAccountKeysResponse ListServiceAccountKeys(ListServiceAccountKeysRequest request, CallOptions options)

Lists every [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey] for a service account.

Parameters
NameDescription
requestListServiceAccountKeysRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListServiceAccountKeysResponse

The response received from the server.

ListServiceAccountKeys(ListServiceAccountKeysRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListServiceAccountKeysResponse ListServiceAccountKeys(ListServiceAccountKeysRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists every [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey] for a service account.

Parameters
NameDescription
requestListServiceAccountKeysRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListServiceAccountKeysResponse

The response received from the server.

ListServiceAccountKeysAsync(ListServiceAccountKeysRequest, CallOptions)

public virtual AsyncUnaryCall<ListServiceAccountKeysResponse> ListServiceAccountKeysAsync(ListServiceAccountKeysRequest request, CallOptions options)

Lists every [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey] for a service account.

Parameters
NameDescription
requestListServiceAccountKeysRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListServiceAccountKeysResponse>

The call object.

ListServiceAccountKeysAsync(ListServiceAccountKeysRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListServiceAccountKeysResponse> ListServiceAccountKeysAsync(ListServiceAccountKeysRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists every [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey] for a service account.

Parameters
NameDescription
requestListServiceAccountKeysRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListServiceAccountKeysResponse>

The call object.

ListServiceAccounts(ListServiceAccountsRequest, CallOptions)

public virtual ListServiceAccountsResponse ListServiceAccounts(ListServiceAccountsRequest request, CallOptions options)

Lists every [ServiceAccount][google.iam.admin.v1.ServiceAccount] that belongs to a specific project.

Parameters
NameDescription
requestListServiceAccountsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListServiceAccountsResponse

The response received from the server.

ListServiceAccounts(ListServiceAccountsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListServiceAccountsResponse ListServiceAccounts(ListServiceAccountsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists every [ServiceAccount][google.iam.admin.v1.ServiceAccount] that belongs to a specific project.

Parameters
NameDescription
requestListServiceAccountsRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListServiceAccountsResponse

The response received from the server.

ListServiceAccountsAsync(ListServiceAccountsRequest, CallOptions)

public virtual AsyncUnaryCall<ListServiceAccountsResponse> ListServiceAccountsAsync(ListServiceAccountsRequest request, CallOptions options)

Lists every [ServiceAccount][google.iam.admin.v1.ServiceAccount] that belongs to a specific project.

Parameters
NameDescription
requestListServiceAccountsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListServiceAccountsResponse>

The call object.

ListServiceAccountsAsync(ListServiceAccountsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListServiceAccountsResponse> ListServiceAccountsAsync(ListServiceAccountsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists every [ServiceAccount][google.iam.admin.v1.ServiceAccount] that belongs to a specific project.

Parameters
NameDescription
requestListServiceAccountsRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListServiceAccountsResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override IAM.IAMClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
IAM.IAMClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Iam.Admin.V1.IAM.IAMClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

PatchServiceAccount(PatchServiceAccountRequest, CallOptions)

public virtual ServiceAccount PatchServiceAccount(PatchServiceAccountRequest request, CallOptions options)

Patches a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Parameters
NameDescription
requestPatchServiceAccountRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ServiceAccount

The response received from the server.

PatchServiceAccount(PatchServiceAccountRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ServiceAccount PatchServiceAccount(PatchServiceAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Patches a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Parameters
NameDescription
requestPatchServiceAccountRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ServiceAccount

The response received from the server.

PatchServiceAccountAsync(PatchServiceAccountRequest, CallOptions)

public virtual AsyncUnaryCall<ServiceAccount> PatchServiceAccountAsync(PatchServiceAccountRequest request, CallOptions options)

Patches a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Parameters
NameDescription
requestPatchServiceAccountRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ServiceAccount>

The call object.

PatchServiceAccountAsync(PatchServiceAccountRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ServiceAccount> PatchServiceAccountAsync(PatchServiceAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Patches a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Parameters
NameDescription
requestPatchServiceAccountRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ServiceAccount>

The call object.

QueryAuditableServices(QueryAuditableServicesRequest, CallOptions)

public virtual QueryAuditableServicesResponse QueryAuditableServices(QueryAuditableServicesRequest request, CallOptions options)

Returns a list of services that allow you to opt into audit logs that are not generated by default.

To learn more about audit logs, see the Logging documentation.

Parameters
NameDescription
requestQueryAuditableServicesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
QueryAuditableServicesResponse

The response received from the server.

QueryAuditableServices(QueryAuditableServicesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual QueryAuditableServicesResponse QueryAuditableServices(QueryAuditableServicesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns a list of services that allow you to opt into audit logs that are not generated by default.

To learn more about audit logs, see the Logging documentation.

Parameters
NameDescription
requestQueryAuditableServicesRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
QueryAuditableServicesResponse

The response received from the server.

QueryAuditableServicesAsync(QueryAuditableServicesRequest, CallOptions)

public virtual AsyncUnaryCall<QueryAuditableServicesResponse> QueryAuditableServicesAsync(QueryAuditableServicesRequest request, CallOptions options)

Returns a list of services that allow you to opt into audit logs that are not generated by default.

To learn more about audit logs, see the Logging documentation.

Parameters
NameDescription
requestQueryAuditableServicesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<QueryAuditableServicesResponse>

The call object.

QueryAuditableServicesAsync(QueryAuditableServicesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<QueryAuditableServicesResponse> QueryAuditableServicesAsync(QueryAuditableServicesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns a list of services that allow you to opt into audit logs that are not generated by default.

To learn more about audit logs, see the Logging documentation.

Parameters
NameDescription
requestQueryAuditableServicesRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<QueryAuditableServicesResponse>

The call object.

QueryGrantableRoles(QueryGrantableRolesRequest, CallOptions)

public virtual QueryGrantableRolesResponse QueryGrantableRoles(QueryGrantableRolesRequest request, CallOptions options)

Lists roles that can be granted on a Google Cloud resource. A role is grantable if the IAM policy for the resource can contain bindings to the role.

Parameters
NameDescription
requestQueryGrantableRolesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
QueryGrantableRolesResponse

The response received from the server.

QueryGrantableRoles(QueryGrantableRolesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual QueryGrantableRolesResponse QueryGrantableRoles(QueryGrantableRolesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists roles that can be granted on a Google Cloud resource. A role is grantable if the IAM policy for the resource can contain bindings to the role.

Parameters
NameDescription
requestQueryGrantableRolesRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
QueryGrantableRolesResponse

The response received from the server.

QueryGrantableRolesAsync(QueryGrantableRolesRequest, CallOptions)

public virtual AsyncUnaryCall<QueryGrantableRolesResponse> QueryGrantableRolesAsync(QueryGrantableRolesRequest request, CallOptions options)

Lists roles that can be granted on a Google Cloud resource. A role is grantable if the IAM policy for the resource can contain bindings to the role.

Parameters
NameDescription
requestQueryGrantableRolesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<QueryGrantableRolesResponse>

The call object.

QueryGrantableRolesAsync(QueryGrantableRolesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<QueryGrantableRolesResponse> QueryGrantableRolesAsync(QueryGrantableRolesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists roles that can be granted on a Google Cloud resource. A role is grantable if the IAM policy for the resource can contain bindings to the role.

Parameters
NameDescription
requestQueryGrantableRolesRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<QueryGrantableRolesResponse>

The call object.

QueryTestablePermissions(QueryTestablePermissionsRequest, CallOptions)

public virtual QueryTestablePermissionsResponse QueryTestablePermissions(QueryTestablePermissionsRequest request, CallOptions options)

Lists every permission that you can test on a resource. A permission is testable if you can check whether a principal has that permission on the resource.

Parameters
NameDescription
requestQueryTestablePermissionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
QueryTestablePermissionsResponse

The response received from the server.

QueryTestablePermissions(QueryTestablePermissionsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual QueryTestablePermissionsResponse QueryTestablePermissions(QueryTestablePermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists every permission that you can test on a resource. A permission is testable if you can check whether a principal has that permission on the resource.

Parameters
NameDescription
requestQueryTestablePermissionsRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
QueryTestablePermissionsResponse

The response received from the server.

QueryTestablePermissionsAsync(QueryTestablePermissionsRequest, CallOptions)

public virtual AsyncUnaryCall<QueryTestablePermissionsResponse> QueryTestablePermissionsAsync(QueryTestablePermissionsRequest request, CallOptions options)

Lists every permission that you can test on a resource. A permission is testable if you can check whether a principal has that permission on the resource.

Parameters
NameDescription
requestQueryTestablePermissionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<QueryTestablePermissionsResponse>

The call object.

QueryTestablePermissionsAsync(QueryTestablePermissionsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<QueryTestablePermissionsResponse> QueryTestablePermissionsAsync(QueryTestablePermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists every permission that you can test on a resource. A permission is testable if you can check whether a principal has that permission on the resource.

Parameters
NameDescription
requestQueryTestablePermissionsRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<QueryTestablePermissionsResponse>

The call object.

SetIamPolicy(SetIamPolicyRequest, CallOptions)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, CallOptions options)

Sets the IAM policy that is attached to a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Use this method to grant or revoke access to the service account. For example, you could grant a principal the ability to impersonate the service account.

This method does not enable the service account to access other resources. To grant roles to a service account on a resource, follow these steps:

  1. Call the resource's getIamPolicy method to get its current IAM policy.
  2. Edit the policy so that it binds the service account to an IAM role for the resource.
  3. Call the resource's setIamPolicy method to update its IAM policy.

For detailed instructions, see Manage access to project, folders, and organizations or Manage access to other resources.

Parameters
NameDescription
requestSetIamPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Policy

The response received from the server.

SetIamPolicy(SetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Sets the IAM policy that is attached to a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Use this method to grant or revoke access to the service account. For example, you could grant a principal the ability to impersonate the service account.

This method does not enable the service account to access other resources. To grant roles to a service account on a resource, follow these steps:

  1. Call the resource's getIamPolicy method to get its current IAM policy.
  2. Edit the policy so that it binds the service account to an IAM role for the resource.
  3. Call the resource's setIamPolicy method to update its IAM policy.

For detailed instructions, see Manage access to project, folders, and organizations or Manage access to other resources.

Parameters
NameDescription
requestSetIamPolicyRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Policy

The response received from the server.

SetIamPolicyAsync(SetIamPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallOptions options)

Sets the IAM policy that is attached to a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Use this method to grant or revoke access to the service account. For example, you could grant a principal the ability to impersonate the service account.

This method does not enable the service account to access other resources. To grant roles to a service account on a resource, follow these steps:

  1. Call the resource's getIamPolicy method to get its current IAM policy.
  2. Edit the policy so that it binds the service account to an IAM role for the resource.
  3. Call the resource's setIamPolicy method to update its IAM policy.

For detailed instructions, see Manage access to project, folders, and organizations or Manage access to other resources.

Parameters
NameDescription
requestSetIamPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Policy>

The call object.

SetIamPolicyAsync(SetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Sets the IAM policy that is attached to a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Use this method to grant or revoke access to the service account. For example, you could grant a principal the ability to impersonate the service account.

This method does not enable the service account to access other resources. To grant roles to a service account on a resource, follow these steps:

  1. Call the resource's getIamPolicy method to get its current IAM policy.
  2. Edit the policy so that it binds the service account to an IAM role for the resource.
  3. Call the resource's setIamPolicy method to update its IAM policy.

For detailed instructions, see Manage access to project, folders, and organizations or Manage access to other resources.

Parameters
NameDescription
requestSetIamPolicyRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Policy>

The call object.

SignBlob(SignBlobRequest, CallOptions)

public virtual SignBlobResponse SignBlob(SignBlobRequest request, CallOptions options)

Note: This method is deprecated. Use the signBlob method in the IAM Service Account Credentials API instead. If you currently use this method, see the migration guide for instructions.

Signs a blob using the system-managed private key for a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Parameters
NameDescription
requestSignBlobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
SignBlobResponse

The response received from the server.

SignBlob(SignBlobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual SignBlobResponse SignBlob(SignBlobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Note: This method is deprecated. Use the signBlob method in the IAM Service Account Credentials API instead. If you currently use this method, see the migration guide for instructions.

Signs a blob using the system-managed private key for a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Parameters
NameDescription
requestSignBlobRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
SignBlobResponse

The response received from the server.

SignBlobAsync(SignBlobRequest, CallOptions)

public virtual AsyncUnaryCall<SignBlobResponse> SignBlobAsync(SignBlobRequest request, CallOptions options)

Note: This method is deprecated. Use the signBlob method in the IAM Service Account Credentials API instead. If you currently use this method, see the migration guide for instructions.

Signs a blob using the system-managed private key for a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Parameters
NameDescription
requestSignBlobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<SignBlobResponse>

The call object.

SignBlobAsync(SignBlobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<SignBlobResponse> SignBlobAsync(SignBlobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Note: This method is deprecated. Use the signBlob method in the IAM Service Account Credentials API instead. If you currently use this method, see the migration guide for instructions.

Signs a blob using the system-managed private key for a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Parameters
NameDescription
requestSignBlobRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<SignBlobResponse>

The call object.

SignJwt(SignJwtRequest, CallOptions)

public virtual SignJwtResponse SignJwt(SignJwtRequest request, CallOptions options)

Note: This method is deprecated. Use the signJwt method in the IAM Service Account Credentials API instead. If you currently use this method, see the migration guide for instructions.

Signs a JSON Web Token (JWT) using the system-managed private key for a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Parameters
NameDescription
requestSignJwtRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
SignJwtResponse

The response received from the server.

SignJwt(SignJwtRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual SignJwtResponse SignJwt(SignJwtRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Note: This method is deprecated. Use the signJwt method in the IAM Service Account Credentials API instead. If you currently use this method, see the migration guide for instructions.

Signs a JSON Web Token (JWT) using the system-managed private key for a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Parameters
NameDescription
requestSignJwtRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
SignJwtResponse

The response received from the server.

SignJwtAsync(SignJwtRequest, CallOptions)

public virtual AsyncUnaryCall<SignJwtResponse> SignJwtAsync(SignJwtRequest request, CallOptions options)

Note: This method is deprecated. Use the signJwt method in the IAM Service Account Credentials API instead. If you currently use this method, see the migration guide for instructions.

Signs a JSON Web Token (JWT) using the system-managed private key for a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Parameters
NameDescription
requestSignJwtRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<SignJwtResponse>

The call object.

SignJwtAsync(SignJwtRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<SignJwtResponse> SignJwtAsync(SignJwtRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Note: This method is deprecated. Use the signJwt method in the IAM Service Account Credentials API instead. If you currently use this method, see the migration guide for instructions.

Signs a JSON Web Token (JWT) using the system-managed private key for a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Parameters
NameDescription
requestSignJwtRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<SignJwtResponse>

The call object.

TestIamPermissions(TestIamPermissionsRequest, CallOptions)

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallOptions options)

Tests whether the caller has the specified permissions on a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Parameters
NameDescription
requestTestIamPermissionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
TestIamPermissionsResponse

The response received from the server.

TestIamPermissions(TestIamPermissionsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Tests whether the caller has the specified permissions on a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Parameters
NameDescription
requestTestIamPermissionsRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
TestIamPermissionsResponse

The response received from the server.

TestIamPermissionsAsync(TestIamPermissionsRequest, CallOptions)

public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallOptions options)

Tests whether the caller has the specified permissions on a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Parameters
NameDescription
requestTestIamPermissionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<TestIamPermissionsResponse>

The call object.

TestIamPermissionsAsync(TestIamPermissionsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Tests whether the caller has the specified permissions on a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Parameters
NameDescription
requestTestIamPermissionsRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<TestIamPermissionsResponse>

The call object.

UndeleteRole(UndeleteRoleRequest, CallOptions)

public virtual Role UndeleteRole(UndeleteRoleRequest request, CallOptions options)

Undeletes a custom [Role][google.iam.admin.v1.Role].

Parameters
NameDescription
requestUndeleteRoleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Role

The response received from the server.

UndeleteRole(UndeleteRoleRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Role UndeleteRole(UndeleteRoleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Undeletes a custom [Role][google.iam.admin.v1.Role].

Parameters
NameDescription
requestUndeleteRoleRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Role

The response received from the server.

UndeleteRoleAsync(UndeleteRoleRequest, CallOptions)

public virtual AsyncUnaryCall<Role> UndeleteRoleAsync(UndeleteRoleRequest request, CallOptions options)

Undeletes a custom [Role][google.iam.admin.v1.Role].

Parameters
NameDescription
requestUndeleteRoleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Role>

The call object.

UndeleteRoleAsync(UndeleteRoleRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Role> UndeleteRoleAsync(UndeleteRoleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Undeletes a custom [Role][google.iam.admin.v1.Role].

Parameters
NameDescription
requestUndeleteRoleRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Role>

The call object.

UndeleteServiceAccount(UndeleteServiceAccountRequest, CallOptions)

public virtual UndeleteServiceAccountResponse UndeleteServiceAccount(UndeleteServiceAccountRequest request, CallOptions options)

Restores a deleted [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Important: It is not always possible to restore a deleted service account. Use this method only as a last resort.

After you delete a service account, IAM permanently removes the service account 30 days later. There is no way to restore a deleted service account that has been permanently removed.

Parameters
NameDescription
requestUndeleteServiceAccountRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
UndeleteServiceAccountResponse

The response received from the server.

UndeleteServiceAccount(UndeleteServiceAccountRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual UndeleteServiceAccountResponse UndeleteServiceAccount(UndeleteServiceAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Restores a deleted [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Important: It is not always possible to restore a deleted service account. Use this method only as a last resort.

After you delete a service account, IAM permanently removes the service account 30 days later. There is no way to restore a deleted service account that has been permanently removed.

Parameters
NameDescription
requestUndeleteServiceAccountRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
UndeleteServiceAccountResponse

The response received from the server.

UndeleteServiceAccountAsync(UndeleteServiceAccountRequest, CallOptions)

public virtual AsyncUnaryCall<UndeleteServiceAccountResponse> UndeleteServiceAccountAsync(UndeleteServiceAccountRequest request, CallOptions options)

Restores a deleted [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Important: It is not always possible to restore a deleted service account. Use this method only as a last resort.

After you delete a service account, IAM permanently removes the service account 30 days later. There is no way to restore a deleted service account that has been permanently removed.

Parameters
NameDescription
requestUndeleteServiceAccountRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<UndeleteServiceAccountResponse>

The call object.

UndeleteServiceAccountAsync(UndeleteServiceAccountRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<UndeleteServiceAccountResponse> UndeleteServiceAccountAsync(UndeleteServiceAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Restores a deleted [ServiceAccount][google.iam.admin.v1.ServiceAccount].

Important: It is not always possible to restore a deleted service account. Use this method only as a last resort.

After you delete a service account, IAM permanently removes the service account 30 days later. There is no way to restore a deleted service account that has been permanently removed.

Parameters
NameDescription
requestUndeleteServiceAccountRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<UndeleteServiceAccountResponse>

The call object.

UpdateRole(UpdateRoleRequest, CallOptions)

public virtual Role UpdateRole(UpdateRoleRequest request, CallOptions options)

Updates the definition of a custom [Role][google.iam.admin.v1.Role].

Parameters
NameDescription
requestUpdateRoleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Role

The response received from the server.

UpdateRole(UpdateRoleRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Role UpdateRole(UpdateRoleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Updates the definition of a custom [Role][google.iam.admin.v1.Role].

Parameters
NameDescription
requestUpdateRoleRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Role

The response received from the server.

UpdateRoleAsync(UpdateRoleRequest, CallOptions)

public virtual AsyncUnaryCall<Role> UpdateRoleAsync(UpdateRoleRequest request, CallOptions options)

Updates the definition of a custom [Role][google.iam.admin.v1.Role].

Parameters
NameDescription
requestUpdateRoleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Role>

The call object.

UpdateRoleAsync(UpdateRoleRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Role> UpdateRoleAsync(UpdateRoleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Updates the definition of a custom [Role][google.iam.admin.v1.Role].

Parameters
NameDescription
requestUpdateRoleRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Role>

The call object.

UpdateServiceAccount(ServiceAccount, CallOptions)

public virtual ServiceAccount UpdateServiceAccount(ServiceAccount request, CallOptions options)

Note: We are in the process of deprecating this method. Use [PatchServiceAccount][google.iam.admin.v1.IAM.PatchServiceAccount] instead.

Updates a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

You can update only the display_name field.

Parameters
NameDescription
requestServiceAccount

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ServiceAccount

The response received from the server.

UpdateServiceAccount(ServiceAccount, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ServiceAccount UpdateServiceAccount(ServiceAccount request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Note: We are in the process of deprecating this method. Use [PatchServiceAccount][google.iam.admin.v1.IAM.PatchServiceAccount] instead.

Updates a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

You can update only the display_name field.

Parameters
NameDescription
requestServiceAccount

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ServiceAccount

The response received from the server.

UpdateServiceAccountAsync(ServiceAccount, CallOptions)

public virtual AsyncUnaryCall<ServiceAccount> UpdateServiceAccountAsync(ServiceAccount request, CallOptions options)

Note: We are in the process of deprecating this method. Use [PatchServiceAccount][google.iam.admin.v1.IAM.PatchServiceAccount] instead.

Updates a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

You can update only the display_name field.

Parameters
NameDescription
requestServiceAccount

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ServiceAccount>

The call object.

UpdateServiceAccountAsync(ServiceAccount, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ServiceAccount> UpdateServiceAccountAsync(ServiceAccount request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Note: We are in the process of deprecating this method. Use [PatchServiceAccount][google.iam.admin.v1.IAM.PatchServiceAccount] instead.

Updates a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

You can update only the display_name field.

Parameters
NameDescription
requestServiceAccount

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ServiceAccount>

The call object.

UploadServiceAccountKey(UploadServiceAccountKeyRequest, CallOptions)

public virtual ServiceAccountKey UploadServiceAccountKey(UploadServiceAccountKeyRequest request, CallOptions options)

Uploads the public key portion of a key pair that you manage, and associates the public key with a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

After you upload the public key, you can use the private key from the key pair as a service account key.

Parameters
NameDescription
requestUploadServiceAccountKeyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ServiceAccountKey

The response received from the server.

UploadServiceAccountKey(UploadServiceAccountKeyRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ServiceAccountKey UploadServiceAccountKey(UploadServiceAccountKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Uploads the public key portion of a key pair that you manage, and associates the public key with a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

After you upload the public key, you can use the private key from the key pair as a service account key.

Parameters
NameDescription
requestUploadServiceAccountKeyRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ServiceAccountKey

The response received from the server.

UploadServiceAccountKeyAsync(UploadServiceAccountKeyRequest, CallOptions)

public virtual AsyncUnaryCall<ServiceAccountKey> UploadServiceAccountKeyAsync(UploadServiceAccountKeyRequest request, CallOptions options)

Uploads the public key portion of a key pair that you manage, and associates the public key with a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

After you upload the public key, you can use the private key from the key pair as a service account key.

Parameters
NameDescription
requestUploadServiceAccountKeyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ServiceAccountKey>

The call object.

UploadServiceAccountKeyAsync(UploadServiceAccountKeyRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ServiceAccountKey> UploadServiceAccountKeyAsync(UploadServiceAccountKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Uploads the public key portion of a key pair that you manage, and associates the public key with a [ServiceAccount][google.iam.admin.v1.ServiceAccount].

After you upload the public key, you can use the private key from the key pair as a service account key.

Parameters
NameDescription
requestUploadServiceAccountKeyRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ServiceAccountKey>

The call object.