public class IAM.IAMClient : ClientBase<IAM.IAMClient>Reference documentation and code samples for the Identity and Access Management (IAM) v1 API class IAM.IAMClient.
Client for IAM
Namespace
Google.Cloud.Iam.Admin.V1Assembly
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 | |
|---|---|
| Name | Description |
callInvoker | CallInvokerThe callInvoker to use to make remote calls. |
IAMClient(ChannelBase)
public IAMClient(ChannelBase channel)Creates a new client for IAM
| Parameter | |
|---|---|
| Name | Description |
channel | ChannelBaseThe channel to use to make remote calls. |
IAMClient(ClientBaseConfiguration)
protected IAMClient(ClientBase.ClientBaseConfiguration configuration)Protected constructor to allow creation of configured clients.
| Parameter | |
|---|---|
| Name | Description |
configuration | ClientBaseClientBaseConfigurationThe 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 | |
|---|---|
| Name | Description |
request | CreateRoleRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Role | The response received from the server. |
CreateRole(CreateRoleRequest, Metadata, DateTime?, CancellationToken)
public virtual Role CreateRole(CreateRoleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a new custom [Role][google.iam.admin.v1.Role].
| Parameters | |
|---|---|
| Name | Description |
request | CreateRoleRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | CreateRoleRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallRole | The call object. |
CreateRoleAsync(CreateRoleRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Role> CreateRoleAsync(CreateRoleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a new custom [Role][google.iam.admin.v1.Role].
| Parameters | |
|---|---|
| Name | Description |
request | CreateRoleRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallRole | The call object. |
CreateServiceAccount(CreateServiceAccountRequest, CallOptions)
public virtual ServiceAccount CreateServiceAccount(CreateServiceAccountRequest request, CallOptions options)Creates a [ServiceAccount][google.iam.admin.v1.ServiceAccount].
| Parameters | |
|---|---|
| Name | Description |
request | CreateServiceAccountRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ServiceAccount | The response received from the server. |
CreateServiceAccount(CreateServiceAccountRequest, Metadata, DateTime?, CancellationToken)
public virtual ServiceAccount CreateServiceAccount(CreateServiceAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a [ServiceAccount][google.iam.admin.v1.ServiceAccount].
| Parameters | |
|---|---|
| Name | Description |
request | CreateServiceAccountRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | CreateServiceAccountRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallServiceAccount | The call object. |
CreateServiceAccountAsync(CreateServiceAccountRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ServiceAccount> CreateServiceAccountAsync(CreateServiceAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a [ServiceAccount][google.iam.admin.v1.ServiceAccount].
| Parameters | |
|---|---|
| Name | Description |
request | CreateServiceAccountRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallServiceAccount | The call object. |
CreateServiceAccountKey(CreateServiceAccountKeyRequest, CallOptions)
public virtual ServiceAccountKey CreateServiceAccountKey(CreateServiceAccountKeyRequest request, CallOptions options)Creates a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey].
| Parameters | |
|---|---|
| Name | Description |
request | CreateServiceAccountKeyRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ServiceAccountKey | The response received from the server. |
CreateServiceAccountKey(CreateServiceAccountKeyRequest, Metadata, DateTime?, CancellationToken)
public virtual ServiceAccountKey CreateServiceAccountKey(CreateServiceAccountKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey].
| Parameters | |
|---|---|
| Name | Description |
request | CreateServiceAccountKeyRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | CreateServiceAccountKeyRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallServiceAccountKey | The call object. |
CreateServiceAccountKeyAsync(CreateServiceAccountKeyRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ServiceAccountKey> CreateServiceAccountKeyAsync(CreateServiceAccountKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey].
| Parameters | |
|---|---|
| Name | Description |
request | CreateServiceAccountKeyRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallServiceAccountKey | 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 | |
|---|---|
| Name | Description |
request | DeleteRoleRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Role | The response received from the server. |
DeleteRole(DeleteRoleRequest, Metadata, DateTime?, CancellationToken)
public virtual Role DeleteRole(DeleteRoleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | DeleteRoleRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | DeleteRoleRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallRole | The call object. |
DeleteRoleAsync(DeleteRoleRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Role> DeleteRoleAsync(DeleteRoleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | DeleteRoleRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallRole | 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 | |
|---|---|
| Name | Description |
request | DeleteServiceAccountRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Empty | The response received from the server. |
DeleteServiceAccount(DeleteServiceAccountRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty DeleteServiceAccount(DeleteServiceAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | DeleteServiceAccountRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | DeleteServiceAccountRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty | The call object. |
DeleteServiceAccountAsync(DeleteServiceAccountRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteServiceAccountAsync(DeleteServiceAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | DeleteServiceAccountRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty | 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 | |
|---|---|
| Name | Description |
request | DeleteServiceAccountKeyRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Empty | The response received from the server. |
DeleteServiceAccountKey(DeleteServiceAccountKeyRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty DeleteServiceAccountKey(DeleteServiceAccountKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | DeleteServiceAccountKeyRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | DeleteServiceAccountKeyRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty | The call object. |
DeleteServiceAccountKeyAsync(DeleteServiceAccountKeyRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteServiceAccountKeyAsync(DeleteServiceAccountKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | DeleteServiceAccountKeyRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty | 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 | |
|---|---|
| Name | Description |
request | DisableServiceAccountRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Empty | The response received from the server. |
DisableServiceAccount(DisableServiceAccountRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty DisableServiceAccount(DisableServiceAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | DisableServiceAccountRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | DisableServiceAccountRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty | The call object. |
DisableServiceAccountAsync(DisableServiceAccountRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> DisableServiceAccountAsync(DisableServiceAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | DisableServiceAccountRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty | 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 | |
|---|---|
| Name | Description |
request | DisableServiceAccountKeyRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Empty | The response received from the server. |
DisableServiceAccountKey(DisableServiceAccountKeyRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty DisableServiceAccountKey(DisableServiceAccountKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | DisableServiceAccountKeyRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | DisableServiceAccountKeyRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty | The call object. |
DisableServiceAccountKeyAsync(DisableServiceAccountKeyRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> DisableServiceAccountKeyAsync(DisableServiceAccountKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | DisableServiceAccountKeyRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty | 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 | |
|---|---|
| Name | Description |
request | EnableServiceAccountRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Empty | The response received from the server. |
EnableServiceAccount(EnableServiceAccountRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty EnableServiceAccount(EnableServiceAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | EnableServiceAccountRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | EnableServiceAccountRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty | The call object. |
EnableServiceAccountAsync(EnableServiceAccountRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> EnableServiceAccountAsync(EnableServiceAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | EnableServiceAccountRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty | The call object. |
EnableServiceAccountKey(EnableServiceAccountKeyRequest, CallOptions)
public virtual Empty EnableServiceAccountKey(EnableServiceAccountKeyRequest request, CallOptions options)Enable a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey].
| Parameters | |
|---|---|
| Name | Description |
request | EnableServiceAccountKeyRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Empty | The response received from the server. |
EnableServiceAccountKey(EnableServiceAccountKeyRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty EnableServiceAccountKey(EnableServiceAccountKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Enable a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey].
| Parameters | |
|---|---|
| Name | Description |
request | EnableServiceAccountKeyRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | EnableServiceAccountKeyRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty | The call object. |
EnableServiceAccountKeyAsync(EnableServiceAccountKeyRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> EnableServiceAccountKeyAsync(EnableServiceAccountKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Enable a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey].
| Parameters | |
|---|---|
| Name | Description |
request | EnableServiceAccountKeyRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallEmpty | 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 | |
|---|---|
| Name | Description |
request | GetIamPolicyRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Policy | The response received from the server. |
GetIamPolicy(GetIamPolicyRequest, Metadata, DateTime?, CancellationToken)
public virtual Policy GetIamPolicy(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | GetIamPolicyRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | GetIamPolicyRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallPolicy | The call object. |
GetIamPolicyAsync(GetIamPolicyRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | GetIamPolicyRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallPolicy | 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 | |
|---|---|
| Name | Description |
request | GetRoleRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Role | The response received from the server. |
GetRole(GetRoleRequest, Metadata, DateTime?, CancellationToken)
public virtual Role GetRole(GetRoleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets the definition of a [Role][google.iam.admin.v1.Role].
| Parameters | |
|---|---|
| Name | Description |
request | GetRoleRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | GetRoleRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallRole | The call object. |
GetRoleAsync(GetRoleRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Role> GetRoleAsync(GetRoleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets the definition of a [Role][google.iam.admin.v1.Role].
| Parameters | |
|---|---|
| Name | Description |
request | GetRoleRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallRole | The call object. |
GetServiceAccount(GetServiceAccountRequest, CallOptions)
public virtual ServiceAccount GetServiceAccount(GetServiceAccountRequest request, CallOptions options)Gets a [ServiceAccount][google.iam.admin.v1.ServiceAccount].
| Parameters | |
|---|---|
| Name | Description |
request | GetServiceAccountRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ServiceAccount | The response received from the server. |
GetServiceAccount(GetServiceAccountRequest, Metadata, DateTime?, CancellationToken)
public virtual ServiceAccount GetServiceAccount(GetServiceAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets a [ServiceAccount][google.iam.admin.v1.ServiceAccount].
| Parameters | |
|---|---|
| Name | Description |
request | GetServiceAccountRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | GetServiceAccountRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallServiceAccount | The call object. |
GetServiceAccountAsync(GetServiceAccountRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ServiceAccount> GetServiceAccountAsync(GetServiceAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets a [ServiceAccount][google.iam.admin.v1.ServiceAccount].
| Parameters | |
|---|---|
| Name | Description |
request | GetServiceAccountRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallServiceAccount | The call object. |
GetServiceAccountKey(GetServiceAccountKeyRequest, CallOptions)
public virtual ServiceAccountKey GetServiceAccountKey(GetServiceAccountKeyRequest request, CallOptions options)Gets a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey].
| Parameters | |
|---|---|
| Name | Description |
request | GetServiceAccountKeyRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ServiceAccountKey | The response received from the server. |
GetServiceAccountKey(GetServiceAccountKeyRequest, Metadata, DateTime?, CancellationToken)
public virtual ServiceAccountKey GetServiceAccountKey(GetServiceAccountKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey].
| Parameters | |
|---|---|
| Name | Description |
request | GetServiceAccountKeyRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | GetServiceAccountKeyRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallServiceAccountKey | The call object. |
GetServiceAccountKeyAsync(GetServiceAccountKeyRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ServiceAccountKey> GetServiceAccountKeyAsync(GetServiceAccountKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey].
| Parameters | |
|---|---|
| Name | Description |
request | GetServiceAccountKeyRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallServiceAccountKey | 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 | |
|---|---|
| Name | Description |
request | LintPolicyRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
LintPolicyResponse | The response received from the server. |
LintPolicy(LintPolicyRequest, Metadata, DateTime?, CancellationToken)
public virtual LintPolicyResponse LintPolicy(LintPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | LintPolicyRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | LintPolicyRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallLintPolicyResponse | The call object. |
LintPolicyAsync(LintPolicyRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<LintPolicyResponse> LintPolicyAsync(LintPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | LintPolicyRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallLintPolicyResponse | 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 | |
|---|---|
| Name | Description |
request | ListRolesRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListRolesResponse | The response received from the server. |
ListRoles(ListRolesRequest, Metadata, DateTime?, CancellationToken)
public virtual ListRolesResponse ListRoles(ListRolesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | ListRolesRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | ListRolesRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListRolesResponse | The call object. |
ListRolesAsync(ListRolesRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListRolesResponse> ListRolesAsync(ListRolesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | ListRolesRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListRolesResponse | 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 | |
|---|---|
| Name | Description |
request | ListServiceAccountKeysRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListServiceAccountKeysResponse | The response received from the server. |
ListServiceAccountKeys(ListServiceAccountKeysRequest, Metadata, DateTime?, CancellationToken)
public virtual ListServiceAccountKeysResponse ListServiceAccountKeys(ListServiceAccountKeysRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists every [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey] for a service account.
| Parameters | |
|---|---|
| Name | Description |
request | ListServiceAccountKeysRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | ListServiceAccountKeysRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListServiceAccountKeysResponse | The call object. |
ListServiceAccountKeysAsync(ListServiceAccountKeysRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListServiceAccountKeysResponse> ListServiceAccountKeysAsync(ListServiceAccountKeysRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists every [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey] for a service account.
| Parameters | |
|---|---|
| Name | Description |
request | ListServiceAccountKeysRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListServiceAccountKeysResponse | 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 | |
|---|---|
| Name | Description |
request | ListServiceAccountsRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListServiceAccountsResponse | The response received from the server. |
ListServiceAccounts(ListServiceAccountsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListServiceAccountsResponse ListServiceAccounts(ListServiceAccountsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists every [ServiceAccount][google.iam.admin.v1.ServiceAccount] that belongs to a specific project.
| Parameters | |
|---|---|
| Name | Description |
request | ListServiceAccountsRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | ListServiceAccountsRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListServiceAccountsResponse | The call object. |
ListServiceAccountsAsync(ListServiceAccountsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListServiceAccountsResponse> ListServiceAccountsAsync(ListServiceAccountsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists every [ServiceAccount][google.iam.admin.v1.ServiceAccount] that belongs to a specific project.
| Parameters | |
|---|---|
| Name | Description |
request | ListServiceAccountsRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListServiceAccountsResponse | The call object. |
NewInstance(ClientBaseConfiguration)
protected override IAM.IAMClient NewInstance(ClientBase.ClientBaseConfiguration configuration)Creates a new instance of client from given ClientBaseConfiguration.
| Parameter | |
|---|---|
| Name | Description |
configuration | ClientBaseClientBaseConfiguration |
| Returns | |
|---|---|
| Type | Description |
IAMIAMClient | |
PatchServiceAccount(PatchServiceAccountRequest, CallOptions)
public virtual ServiceAccount PatchServiceAccount(PatchServiceAccountRequest request, CallOptions options)Patches a [ServiceAccount][google.iam.admin.v1.ServiceAccount].
| Parameters | |
|---|---|
| Name | Description |
request | PatchServiceAccountRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ServiceAccount | The response received from the server. |
PatchServiceAccount(PatchServiceAccountRequest, Metadata, DateTime?, CancellationToken)
public virtual ServiceAccount PatchServiceAccount(PatchServiceAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Patches a [ServiceAccount][google.iam.admin.v1.ServiceAccount].
| Parameters | |
|---|---|
| Name | Description |
request | PatchServiceAccountRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | PatchServiceAccountRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallServiceAccount | The call object. |
PatchServiceAccountAsync(PatchServiceAccountRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ServiceAccount> PatchServiceAccountAsync(PatchServiceAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Patches a [ServiceAccount][google.iam.admin.v1.ServiceAccount].
| Parameters | |
|---|---|
| Name | Description |
request | PatchServiceAccountRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallServiceAccount | 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 | |
|---|---|
| Name | Description |
request | QueryAuditableServicesRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
QueryAuditableServicesResponse | The response received from the server. |
QueryAuditableServices(QueryAuditableServicesRequest, Metadata, DateTime?, CancellationToken)
public virtual QueryAuditableServicesResponse QueryAuditableServices(QueryAuditableServicesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | QueryAuditableServicesRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | QueryAuditableServicesRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallQueryAuditableServicesResponse | The call object. |
QueryAuditableServicesAsync(QueryAuditableServicesRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<QueryAuditableServicesResponse> QueryAuditableServicesAsync(QueryAuditableServicesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | QueryAuditableServicesRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallQueryAuditableServicesResponse | 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 | |
|---|---|
| Name | Description |
request | QueryGrantableRolesRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
QueryGrantableRolesResponse | The response received from the server. |
QueryGrantableRoles(QueryGrantableRolesRequest, Metadata, DateTime?, CancellationToken)
public virtual QueryGrantableRolesResponse QueryGrantableRoles(QueryGrantableRolesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | QueryGrantableRolesRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | QueryGrantableRolesRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallQueryGrantableRolesResponse | The call object. |
QueryGrantableRolesAsync(QueryGrantableRolesRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<QueryGrantableRolesResponse> QueryGrantableRolesAsync(QueryGrantableRolesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | QueryGrantableRolesRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallQueryGrantableRolesResponse | 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 | |
|---|---|
| Name | Description |
request | QueryTestablePermissionsRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
QueryTestablePermissionsResponse | The response received from the server. |
QueryTestablePermissions(QueryTestablePermissionsRequest, Metadata, DateTime?, CancellationToken)
public virtual QueryTestablePermissionsResponse QueryTestablePermissions(QueryTestablePermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | QueryTestablePermissionsRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | QueryTestablePermissionsRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallQueryTestablePermissionsResponse | The call object. |
QueryTestablePermissionsAsync(QueryTestablePermissionsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<QueryTestablePermissionsResponse> QueryTestablePermissionsAsync(QueryTestablePermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | QueryTestablePermissionsRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallQueryTestablePermissionsResponse | 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:
- Call the resource's
getIamPolicymethod to get its current IAM policy. - Edit the policy so that it binds the service account to an IAM role for the resource.
- Call the resource's
setIamPolicymethod to update its IAM policy.
For detailed instructions, see Manage access to project, folders, and organizations or Manage access to other resources.
| Parameters | |
|---|---|
| Name | Description |
request | SetIamPolicyRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Policy | The response received from the server. |
SetIamPolicy(SetIamPolicyRequest, Metadata, DateTime?, CancellationToken)
public virtual Policy SetIamPolicy(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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:
- Call the resource's
getIamPolicymethod to get its current IAM policy. - Edit the policy so that it binds the service account to an IAM role for the resource.
- Call the resource's
setIamPolicymethod to update its IAM policy.
For detailed instructions, see Manage access to project, folders, and organizations or Manage access to other resources.
| Parameters | |
|---|---|
| Name | Description |
request | SetIamPolicyRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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:
- Call the resource's
getIamPolicymethod to get its current IAM policy. - Edit the policy so that it binds the service account to an IAM role for the resource.
- Call the resource's
setIamPolicymethod to update its IAM policy.
For detailed instructions, see Manage access to project, folders, and organizations or Manage access to other resources.
| Parameters | |
|---|---|
| Name | Description |
request | SetIamPolicyRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallPolicy | The call object. |
SetIamPolicyAsync(SetIamPolicyRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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:
- Call the resource's
getIamPolicymethod to get its current IAM policy. - Edit the policy so that it binds the service account to an IAM role for the resource.
- Call the resource's
setIamPolicymethod to update its IAM policy.
For detailed instructions, see Manage access to project, folders, and organizations or Manage access to other resources.
| Parameters | |
|---|---|
| Name | Description |
request | SetIamPolicyRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallPolicy | The call object. |
SignBlob(SignBlobRequest, CallOptions)
[Obsolete]
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 | |
|---|---|
| Name | Description |
request | SignBlobRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
SignBlobResponse | The response received from the server. |
SignBlob(SignBlobRequest, Metadata, DateTime?, CancellationToken)
[Obsolete]
public virtual SignBlobResponse SignBlob(SignBlobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | SignBlobRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
SignBlobResponse | The response received from the server. |
SignBlobAsync(SignBlobRequest, CallOptions)
[Obsolete]
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 | |
|---|---|
| Name | Description |
request | SignBlobRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallSignBlobResponse | The call object. |
SignBlobAsync(SignBlobRequest, Metadata, DateTime?, CancellationToken)
[Obsolete]
public virtual AsyncUnaryCall<SignBlobResponse> SignBlobAsync(SignBlobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | SignBlobRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallSignBlobResponse | The call object. |
SignJwt(SignJwtRequest, CallOptions)
[Obsolete]
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 | |
|---|---|
| Name | Description |
request | SignJwtRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
SignJwtResponse | The response received from the server. |
SignJwt(SignJwtRequest, Metadata, DateTime?, CancellationToken)
[Obsolete]
public virtual SignJwtResponse SignJwt(SignJwtRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | SignJwtRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
SignJwtResponse | The response received from the server. |
SignJwtAsync(SignJwtRequest, CallOptions)
[Obsolete]
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 | |
|---|---|
| Name | Description |
request | SignJwtRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallSignJwtResponse | The call object. |
SignJwtAsync(SignJwtRequest, Metadata, DateTime?, CancellationToken)
[Obsolete]
public virtual AsyncUnaryCall<SignJwtResponse> SignJwtAsync(SignJwtRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | SignJwtRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallSignJwtResponse | 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 | |
|---|---|
| Name | Description |
request | TestIamPermissionsRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
TestIamPermissionsResponse | The response received from the server. |
TestIamPermissions(TestIamPermissionsRequest, Metadata, DateTime?, CancellationToken)
public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Tests whether the caller has the specified permissions on a [ServiceAccount][google.iam.admin.v1.ServiceAccount].
| Parameters | |
|---|---|
| Name | Description |
request | TestIamPermissionsRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | TestIamPermissionsRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallTestIamPermissionsResponse | The call object. |
TestIamPermissionsAsync(TestIamPermissionsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Tests whether the caller has the specified permissions on a [ServiceAccount][google.iam.admin.v1.ServiceAccount].
| Parameters | |
|---|---|
| Name | Description |
request | TestIamPermissionsRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallTestIamPermissionsResponse | The call object. |
UndeleteRole(UndeleteRoleRequest, CallOptions)
public virtual Role UndeleteRole(UndeleteRoleRequest request, CallOptions options)Undeletes a custom [Role][google.iam.admin.v1.Role].
| Parameters | |
|---|---|
| Name | Description |
request | UndeleteRoleRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Role | The response received from the server. |
UndeleteRole(UndeleteRoleRequest, Metadata, DateTime?, CancellationToken)
public virtual Role UndeleteRole(UndeleteRoleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Undeletes a custom [Role][google.iam.admin.v1.Role].
| Parameters | |
|---|---|
| Name | Description |
request | UndeleteRoleRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | UndeleteRoleRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallRole | The call object. |
UndeleteRoleAsync(UndeleteRoleRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Role> UndeleteRoleAsync(UndeleteRoleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Undeletes a custom [Role][google.iam.admin.v1.Role].
| Parameters | |
|---|---|
| Name | Description |
request | UndeleteRoleRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallRole | 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 | |
|---|---|
| Name | Description |
request | UndeleteServiceAccountRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
UndeleteServiceAccountResponse | The response received from the server. |
UndeleteServiceAccount(UndeleteServiceAccountRequest, Metadata, DateTime?, CancellationToken)
public virtual UndeleteServiceAccountResponse UndeleteServiceAccount(UndeleteServiceAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | UndeleteServiceAccountRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | UndeleteServiceAccountRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallUndeleteServiceAccountResponse | The call object. |
UndeleteServiceAccountAsync(UndeleteServiceAccountRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<UndeleteServiceAccountResponse> UndeleteServiceAccountAsync(UndeleteServiceAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | UndeleteServiceAccountRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallUndeleteServiceAccountResponse | 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 | |
|---|---|
| Name | Description |
request | UpdateRoleRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Role | The response received from the server. |
UpdateRole(UpdateRoleRequest, Metadata, DateTime?, CancellationToken)
public virtual Role UpdateRole(UpdateRoleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates the definition of a custom [Role][google.iam.admin.v1.Role].
| Parameters | |
|---|---|
| Name | Description |
request | UpdateRoleRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | UpdateRoleRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallRole | The call object. |
UpdateRoleAsync(UpdateRoleRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Role> UpdateRoleAsync(UpdateRoleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates the definition of a custom [Role][google.iam.admin.v1.Role].
| Parameters | |
|---|---|
| Name | Description |
request | UpdateRoleRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallRole | 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 | |
|---|---|
| Name | Description |
request | ServiceAccountThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ServiceAccount | The response received from the server. |
UpdateServiceAccount(ServiceAccount, Metadata, DateTime?, CancellationToken)
public virtual ServiceAccount UpdateServiceAccount(ServiceAccount request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | ServiceAccountThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | ServiceAccountThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallServiceAccount | The call object. |
UpdateServiceAccountAsync(ServiceAccount, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ServiceAccount> UpdateServiceAccountAsync(ServiceAccount request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | ServiceAccountThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallServiceAccount | 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 | |
|---|---|
| Name | Description |
request | UploadServiceAccountKeyRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ServiceAccountKey | The response received from the server. |
UploadServiceAccountKey(UploadServiceAccountKeyRequest, Metadata, DateTime?, CancellationToken)
public virtual ServiceAccountKey UploadServiceAccountKey(UploadServiceAccountKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | UploadServiceAccountKeyRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request | UploadServiceAccountKeyRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallServiceAccountKey | The call object. |
UploadServiceAccountKeyAsync(UploadServiceAccountKeyRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ServiceAccountKey> UploadServiceAccountKeyAsync(UploadServiceAccountKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 | |
|---|---|
| Name | Description |
request | UploadServiceAccountKeyRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallServiceAccountKey | The call object. |