Interface IAMGrpc.AsyncService (3.49.0) 

public static interface IAMGrpc.AsyncService

Creates and manages Identity and Access Management (IAM) resources. You can use this service to work with all of the following resources:

  • Service accounts, which identify an application or a virtual machine (VM) instance rather than a person
  • Service account keys, which service accounts use to authenticate with Google APIs
  • IAM policies for service accounts, which specify the roles that a principal has for the service account
  • IAM custom roles, which help you limit the number of permissions that you grant to principals In addition, you can use this service to complete the following tasks, among others:
  • Test whether a service account can use specific permissions
  • Check which roles you can grant for a specific resource
  • Lint, or validate, condition expressions in an IAM policy When you read data from the IAM API, each read is eventually consistent. In other words, if you write data with the IAM API, then immediately read that data, the read operation might return an older version of the data. To deal with this behavior, your application can retry the request with truncated exponential backoff. In contrast, writing data to the IAM API is sequentially consistent. In other words, write operations are always processed in the order in which they were received.

Methods

createRole(CreateRoleRequest request, StreamObserver<Role> responseObserver)

public default void createRole(CreateRoleRequest request, StreamObserver<Role> responseObserver)

Creates a new custom Role.

Parameters
Name Description
request CreateRoleRequest
responseObserver io.grpc.stub.StreamObserver<Role>

createServiceAccount(CreateServiceAccountRequest request, StreamObserver<ServiceAccount> responseObserver)

public default void createServiceAccount(CreateServiceAccountRequest request, StreamObserver<ServiceAccount> responseObserver)

Creates a ServiceAccount.

Parameters
Name Description
request CreateServiceAccountRequest
responseObserver io.grpc.stub.StreamObserver<ServiceAccount>

createServiceAccountKey(CreateServiceAccountKeyRequest request, StreamObserver<ServiceAccountKey> responseObserver)

public default void createServiceAccountKey(CreateServiceAccountKeyRequest request, StreamObserver<ServiceAccountKey> responseObserver)

Creates a ServiceAccountKey.

Parameters
Name Description
request CreateServiceAccountKeyRequest
responseObserver io.grpc.stub.StreamObserver<ServiceAccountKey>

deleteRole(DeleteRoleRequest request, StreamObserver<Role> responseObserver)

public default void deleteRole(DeleteRoleRequest request, StreamObserver<Role> responseObserver)

Deletes a custom 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.
  • Existing bindings to the custom role are not changed, but they have no effect.
  • By default, the response from 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 DeleteRoleRequest
responseObserver io.grpc.stub.StreamObserver<Role>

deleteServiceAccount(DeleteServiceAccountRequest request, StreamObserver<Empty> responseObserver)

public default void deleteServiceAccount(DeleteServiceAccountRequest request, StreamObserver<Empty> responseObserver)

Deletes a 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 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 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 DeleteServiceAccountRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteServiceAccountKey(DeleteServiceAccountKeyRequest request, StreamObserver<Empty> responseObserver)

public default void deleteServiceAccountKey(DeleteServiceAccountKeyRequest request, StreamObserver<Empty> responseObserver)

Deletes a 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 DeleteServiceAccountKeyRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

disableServiceAccount(DisableServiceAccountRequest request, StreamObserver<Empty> responseObserver)

public default void disableServiceAccount(DisableServiceAccountRequest request, StreamObserver<Empty> responseObserver)

Disables a 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. 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.

Parameters
Name Description
request DisableServiceAccountRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

disableServiceAccountKey(DisableServiceAccountKeyRequest request, StreamObserver<Empty> responseObserver)

public default void disableServiceAccountKey(DisableServiceAccountKeyRequest request, StreamObserver<Empty> responseObserver)

Disable a ServiceAccountKey. A disabled service account key can be re-enabled with EnableServiceAccountKey.

Parameters
Name Description
request DisableServiceAccountKeyRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

enableServiceAccount(EnableServiceAccountRequest request, StreamObserver<Empty> responseObserver)

public default void enableServiceAccount(EnableServiceAccountRequest request, StreamObserver<Empty> responseObserver)

Enables a ServiceAccount that was disabled by 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 EnableServiceAccountRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

enableServiceAccountKey(EnableServiceAccountKeyRequest request, StreamObserver<Empty> responseObserver)

public default void enableServiceAccountKey(EnableServiceAccountKeyRequest request, StreamObserver<Empty> responseObserver)

Enable a ServiceAccountKey.

Parameters
Name Description
request EnableServiceAccountKeyRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

getIamPolicy(GetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

public default void getIamPolicy(GetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

Gets the IAM policy that is attached to a 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 com.google.iam.v1.GetIamPolicyRequest
responseObserver io.grpc.stub.StreamObserver<com.google.iam.v1.Policy>

getRole(GetRoleRequest request, StreamObserver<Role> responseObserver)

public default void getRole(GetRoleRequest request, StreamObserver<Role> responseObserver)

Gets the definition of a Role.

Parameters
Name Description
request GetRoleRequest
responseObserver io.grpc.stub.StreamObserver<Role>

getServiceAccount(GetServiceAccountRequest request, StreamObserver<ServiceAccount> responseObserver)

public default void getServiceAccount(GetServiceAccountRequest request, StreamObserver<ServiceAccount> responseObserver)

Gets a ServiceAccount.

Parameters
Name Description
request GetServiceAccountRequest
responseObserver io.grpc.stub.StreamObserver<ServiceAccount>

getServiceAccountKey(GetServiceAccountKeyRequest request, StreamObserver<ServiceAccountKey> responseObserver)

public default void getServiceAccountKey(GetServiceAccountKeyRequest request, StreamObserver<ServiceAccountKey> responseObserver)

Gets a ServiceAccountKey.

Parameters
Name Description
request GetServiceAccountKeyRequest
responseObserver io.grpc.stub.StreamObserver<ServiceAccountKey>

lintPolicy(LintPolicyRequest request, StreamObserver<LintPolicyResponse> responseObserver)

public default void lintPolicy(LintPolicyRequest request, StreamObserver<LintPolicyResponse> responseObserver)

Lints, or validates, an IAM policy. Currently checks the 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 LintPolicyRequest
responseObserver io.grpc.stub.StreamObserver<LintPolicyResponse>

listRoles(ListRolesRequest request, StreamObserver<ListRolesResponse> responseObserver)

public default void listRoles(ListRolesRequest request, StreamObserver<ListRolesResponse> responseObserver)

Lists every predefined Role that IAM supports, or every custom role that is defined for an organization or project.

Parameters
Name Description
request ListRolesRequest
responseObserver io.grpc.stub.StreamObserver<ListRolesResponse>

listServiceAccountKeys(ListServiceAccountKeysRequest request, StreamObserver<ListServiceAccountKeysResponse> responseObserver)

public default void listServiceAccountKeys(ListServiceAccountKeysRequest request, StreamObserver<ListServiceAccountKeysResponse> responseObserver)

Lists every ServiceAccountKey for a service account.

Parameters
Name Description
request ListServiceAccountKeysRequest
responseObserver io.grpc.stub.StreamObserver<ListServiceAccountKeysResponse>

listServiceAccounts(ListServiceAccountsRequest request, StreamObserver<ListServiceAccountsResponse> responseObserver)

public default void listServiceAccounts(ListServiceAccountsRequest request, StreamObserver<ListServiceAccountsResponse> responseObserver)

Lists every ServiceAccount that belongs to a specific project.

Parameters
Name Description
request ListServiceAccountsRequest
responseObserver io.grpc.stub.StreamObserver<ListServiceAccountsResponse>

patchServiceAccount(PatchServiceAccountRequest request, StreamObserver<ServiceAccount> responseObserver)

public default void patchServiceAccount(PatchServiceAccountRequest request, StreamObserver<ServiceAccount> responseObserver)

Patches a ServiceAccount.

Parameters
Name Description
request PatchServiceAccountRequest
responseObserver io.grpc.stub.StreamObserver<ServiceAccount>

queryAuditableServices(QueryAuditableServicesRequest request, StreamObserver<QueryAuditableServicesResponse> responseObserver)

public default void queryAuditableServices(QueryAuditableServicesRequest request, StreamObserver<QueryAuditableServicesResponse> responseObserver)

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 QueryAuditableServicesRequest
responseObserver io.grpc.stub.StreamObserver<QueryAuditableServicesResponse>

queryGrantableRoles(QueryGrantableRolesRequest request, StreamObserver<QueryGrantableRolesResponse> responseObserver)

public default void queryGrantableRoles(QueryGrantableRolesRequest request, StreamObserver<QueryGrantableRolesResponse> responseObserver)

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 QueryGrantableRolesRequest
responseObserver io.grpc.stub.StreamObserver<QueryGrantableRolesResponse>

queryTestablePermissions(QueryTestablePermissionsRequest request, StreamObserver<QueryTestablePermissionsResponse> responseObserver)

public default void queryTestablePermissions(QueryTestablePermissionsRequest request, StreamObserver<QueryTestablePermissionsResponse> responseObserver)

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 QueryTestablePermissionsRequest
responseObserver io.grpc.stub.StreamObserver<QueryTestablePermissionsResponse>

setIamPolicy(SetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

public default void setIamPolicy(SetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

Sets the IAM policy that is attached to a ServiceAccount. Use this method to grant or revoke access to the service account. For example, you could grant a principal the ability to impersonate the service account. This method does not enable the service account to access other resources. To grant roles to a service account on a resource, follow these steps:

  1. Call the resource's getIamPolicy method to get its current IAM policy.
  2. Edit the policy so that it binds the service account to an IAM role for the resource.
  3. Call the resource's setIamPolicy method to update its IAM policy. For detailed instructions, see Manage access to project, folders, and organizations or Manage access to other resources.
Parameters
Name Description
request com.google.iam.v1.SetIamPolicyRequest
responseObserver io.grpc.stub.StreamObserver<com.google.iam.v1.Policy>

signBlob(SignBlobRequest request, StreamObserver<SignBlobResponse> responseObserver) (deprecated)

public default void signBlob(SignBlobRequest request, StreamObserver<SignBlobResponse> responseObserver)

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.

Parameters
Name Description
request SignBlobRequest
responseObserver io.grpc.stub.StreamObserver<SignBlobResponse>

signJwt(SignJwtRequest request, StreamObserver<SignJwtResponse> responseObserver) (deprecated)

public default void signJwt(SignJwtRequest request, StreamObserver<SignJwtResponse> responseObserver)

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.

Parameters
Name Description
request SignJwtRequest
responseObserver io.grpc.stub.StreamObserver<SignJwtResponse>

testIamPermissions(TestIamPermissionsRequest request, StreamObserver<TestIamPermissionsResponse> responseObserver)

public default void testIamPermissions(TestIamPermissionsRequest request, StreamObserver<TestIamPermissionsResponse> responseObserver)

Tests whether the caller has the specified permissions on a ServiceAccount.

Parameters
Name Description
request com.google.iam.v1.TestIamPermissionsRequest
responseObserver io.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse>

undeleteRole(UndeleteRoleRequest request, StreamObserver<Role> responseObserver)

public default void undeleteRole(UndeleteRoleRequest request, StreamObserver<Role> responseObserver)

Undeletes a custom Role.

Parameters
Name Description
request UndeleteRoleRequest
responseObserver io.grpc.stub.StreamObserver<Role>

undeleteServiceAccount(UndeleteServiceAccountRequest request, StreamObserver<UndeleteServiceAccountResponse> responseObserver)

public default void undeleteServiceAccount(UndeleteServiceAccountRequest request, StreamObserver<UndeleteServiceAccountResponse> responseObserver)

Restores a deleted 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 UndeleteServiceAccountRequest
responseObserver io.grpc.stub.StreamObserver<UndeleteServiceAccountResponse>

updateRole(UpdateRoleRequest request, StreamObserver<Role> responseObserver)

public default void updateRole(UpdateRoleRequest request, StreamObserver<Role> responseObserver)

Updates the definition of a custom Role.

Parameters
Name Description
request UpdateRoleRequest
responseObserver io.grpc.stub.StreamObserver<Role>

updateServiceAccount(ServiceAccount request, StreamObserver<ServiceAccount> responseObserver)

public default void updateServiceAccount(ServiceAccount request, StreamObserver<ServiceAccount> responseObserver)

Note: We are in the process of deprecating this method. Use PatchServiceAccount instead. Updates a ServiceAccount. You can update only the display_name field.

Parameters
Name Description
request ServiceAccount
responseObserver io.grpc.stub.StreamObserver<ServiceAccount>

uploadServiceAccountKey(UploadServiceAccountKeyRequest request, StreamObserver<ServiceAccountKey> responseObserver)

public default void uploadServiceAccountKey(UploadServiceAccountKeyRequest request, StreamObserver<ServiceAccountKey> responseObserver)

Uploads the public key portion of a key pair that you manage, and associates the public key with a 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 UploadServiceAccountKeyRequest
responseObserver io.grpc.stub.StreamObserver<ServiceAccountKey>