Google Cloud IAM C++ Client  2.2.1
A C++ Client Library for Google Cloud IAM
Public Member Functions | Friends | List of all members
google::cloud::iam::IAMClient Class Reference

Creates and manages Identity and Access Management (IAM) resources. More...

#include <google/cloud/iam/iam_client.h>

Public Member Functions

 IAMClient (std::shared_ptr< IAMConnection > connection, Options opts={})
 
 ~IAMClient ()
 
 IAMClient (IAMClient const &)=default
 
IAMClientoperator= (IAMClient const &)=default
 
 IAMClient (IAMClient &&)=default
 
IAMClientoperator= (IAMClient &&)=default
 
StreamRange< google::iam::admin::v1::ServiceAccount > ListServiceAccounts (std::string const &name, Options opts={})
 Lists every ServiceAccount that belongs to a specific project. More...
 
StreamRange< google::iam::admin::v1::ServiceAccount > ListServiceAccounts (google::iam::admin::v1::ListServiceAccountsRequest request, Options opts={})
 Lists every ServiceAccount that belongs to a specific project. More...
 
StatusOr< google::iam::admin::v1::ServiceAccount > GetServiceAccount (std::string const &name, Options opts={})
 Gets a ServiceAccount. More...
 
StatusOr< google::iam::admin::v1::ServiceAccount > GetServiceAccount (google::iam::admin::v1::GetServiceAccountRequest const &request, Options opts={})
 Gets a ServiceAccount. More...
 
StatusOr< google::iam::admin::v1::ServiceAccount > CreateServiceAccount (std::string const &name, std::string const &account_id, google::iam::admin::v1::ServiceAccount const &service_account, Options opts={})
 Creates a ServiceAccount. More...
 
StatusOr< google::iam::admin::v1::ServiceAccount > CreateServiceAccount (google::iam::admin::v1::CreateServiceAccountRequest const &request, Options opts={})
 Creates a ServiceAccount. More...
 
StatusOr< google::iam::admin::v1::ServiceAccount > PatchServiceAccount (google::iam::admin::v1::PatchServiceAccountRequest const &request, Options opts={})
 Patches a ServiceAccount. More...
 
Status DeleteServiceAccount (std::string const &name, Options opts={})
 Deletes a [ServiceAccount][google.iam.admin.v1.ServiceAccount]. More...
 
Status DeleteServiceAccount (google::iam::admin::v1::DeleteServiceAccountRequest const &request, Options opts={})
 Deletes a [ServiceAccount][google.iam.admin.v1.ServiceAccount]. More...
 
StatusOr< google::iam::admin::v1::UndeleteServiceAccountResponse > UndeleteServiceAccount (google::iam::admin::v1::UndeleteServiceAccountRequest const &request, Options opts={})
 Restores a deleted [ServiceAccount][google.iam.admin.v1.ServiceAccount]. More...
 
Status EnableServiceAccount (google::iam::admin::v1::EnableServiceAccountRequest const &request, Options opts={})
 Enables a [ServiceAccount][google.iam.admin.v1.ServiceAccount] that was disabled by [DisableServiceAccount][google.iam.admin.v1.IAM.DisableServiceAccount]. More...
 
Status DisableServiceAccount (google::iam::admin::v1::DisableServiceAccountRequest const &request, Options opts={})
 Disables a [ServiceAccount][google.iam.admin.v1.ServiceAccount] immediately. More...
 
StatusOr< google::iam::admin::v1::ListServiceAccountKeysResponse > ListServiceAccountKeys (std::string const &name, std::vector< google::iam::admin::v1::ListServiceAccountKeysRequest::KeyType > const &key_types, Options opts={})
 Lists every [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey] for a service account. More...
 
StatusOr< google::iam::admin::v1::ListServiceAccountKeysResponse > ListServiceAccountKeys (google::iam::admin::v1::ListServiceAccountKeysRequest const &request, Options opts={})
 Lists every [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey] for a service account. More...
 
StatusOr< google::iam::admin::v1::ServiceAccountKey > GetServiceAccountKey (std::string const &name, google::iam::admin::v1::ServiceAccountPublicKeyType public_key_type, Options opts={})
 Gets a ServiceAccountKey. More...
 
StatusOr< google::iam::admin::v1::ServiceAccountKey > GetServiceAccountKey (google::iam::admin::v1::GetServiceAccountKeyRequest const &request, Options opts={})
 Gets a ServiceAccountKey. More...
 
StatusOr< google::iam::admin::v1::ServiceAccountKey > CreateServiceAccountKey (std::string const &name, google::iam::admin::v1::ServiceAccountPrivateKeyType private_key_type, google::iam::admin::v1::ServiceAccountKeyAlgorithm key_algorithm, Options opts={})
 Creates a ServiceAccountKey. More...
 
StatusOr< google::iam::admin::v1::ServiceAccountKey > CreateServiceAccountKey (google::iam::admin::v1::CreateServiceAccountKeyRequest const &request, Options opts={})
 Creates a ServiceAccountKey. More...
 
StatusOr< google::iam::admin::v1::ServiceAccountKey > UploadServiceAccountKey (google::iam::admin::v1::UploadServiceAccountKeyRequest const &request, Options opts={})
 Creates a ServiceAccountKey, using a public key that you provide. More...
 
Status DeleteServiceAccountKey (std::string const &name, Options opts={})
 Deletes a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey]. More...
 
Status DeleteServiceAccountKey (google::iam::admin::v1::DeleteServiceAccountKeyRequest const &request, Options opts={})
 Deletes a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey]. More...
 
StatusOr< google::iam::v1::Policy > GetIamPolicy (std::string const &resource, Options opts={})
 Gets the IAM policy that is attached to a [ServiceAccount][google.iam.admin.v1.ServiceAccount]. More...
 
StatusOr< google::iam::v1::Policy > GetIamPolicy (google::iam::v1::GetIamPolicyRequest const &request, Options opts={})
 Gets the IAM policy that is attached to a [ServiceAccount][google.iam.admin.v1.ServiceAccount]. More...
 
StatusOr< google::iam::v1::Policy > SetIamPolicy (std::string const &resource, google::iam::v1::Policy const &policy, Options opts={})
 Sets the IAM policy that is attached to a [ServiceAccount][google.iam.admin.v1.ServiceAccount]. More...
 
StatusOr< google::iam::v1::Policy > SetIamPolicy (std::string const &resource, IamUpdater const &updater, Options opts={})
 Updates the IAM policy for resource using an optimistic concurrency control loop. More...
 
StatusOr< google::iam::v1::Policy > SetIamPolicy (google::iam::v1::SetIamPolicyRequest const &request, Options opts={})
 Sets the IAM policy that is attached to a [ServiceAccount][google.iam.admin.v1.ServiceAccount]. More...
 
StatusOr< google::iam::v1::TestIamPermissionsResponse > TestIamPermissions (std::string const &resource, std::vector< std::string > const &permissions, Options opts={})
 Tests whether the caller has the specified permissions on a [ServiceAccount][google.iam.admin.v1.ServiceAccount]. More...
 
StatusOr< google::iam::v1::TestIamPermissionsResponse > TestIamPermissions (google::iam::v1::TestIamPermissionsRequest const &request, Options opts={})
 Tests whether the caller has the specified permissions on a [ServiceAccount][google.iam.admin.v1.ServiceAccount]. More...
 
StreamRange< google::iam::admin::v1::Role > QueryGrantableRoles (std::string const &full_resource_name, Options opts={})
 Lists roles that can be granted on a Google Cloud resource. More...
 
StreamRange< google::iam::admin::v1::Role > QueryGrantableRoles (google::iam::admin::v1::QueryGrantableRolesRequest request, Options opts={})
 Lists roles that can be granted on a Google Cloud resource. More...
 
StreamRange< google::iam::admin::v1::Role > ListRoles (google::iam::admin::v1::ListRolesRequest request, Options opts={})
 Lists every predefined Role that IAM supports, or every custom role that is defined for an organization or project. More...
 
StatusOr< google::iam::admin::v1::Role > GetRole (google::iam::admin::v1::GetRoleRequest const &request, Options opts={})
 Gets the definition of a Role. More...
 
StatusOr< google::iam::admin::v1::Role > CreateRole (google::iam::admin::v1::CreateRoleRequest const &request, Options opts={})
 Creates a new custom Role. More...
 
StatusOr< google::iam::admin::v1::Role > UpdateRole (google::iam::admin::v1::UpdateRoleRequest const &request, Options opts={})
 Updates the definition of a custom Role. More...
 
StatusOr< google::iam::admin::v1::Role > DeleteRole (google::iam::admin::v1::DeleteRoleRequest const &request, Options opts={})
 Deletes a custom Role. More...
 
StatusOr< google::iam::admin::v1::Role > UndeleteRole (google::iam::admin::v1::UndeleteRoleRequest const &request, Options opts={})
 Undeletes a custom Role. More...
 
StreamRange< google::iam::admin::v1::Permission > QueryTestablePermissions (google::iam::admin::v1::QueryTestablePermissionsRequest request, Options opts={})
 Lists every permission that you can test on a resource. More...
 
StatusOr< google::iam::admin::v1::QueryAuditableServicesResponse > QueryAuditableServices (google::iam::admin::v1::QueryAuditableServicesRequest const &request, Options opts={})
 Returns a list of services that allow you to opt into audit logs that are not generated by default. More...
 
StatusOr< google::iam::admin::v1::LintPolicyResponse > LintPolicy (google::iam::admin::v1::LintPolicyRequest const &request, Options opts={})
 Lints, or validates, an IAM policy. More...
 

Friends

bool operator== (IAMClient const &a, IAMClient const &b)
 
bool operator!= (IAMClient const &a, IAMClient const &b)
 

Detailed Description

Creates and manages Identity and Access Management (IAM) resources.

You can use this service to work with all of the following resources:

In addition, you can use this service to complete the following tasks, among others:

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Definition at line 80 of file iam_client.h.

Constructor & Destructor Documentation

◆ IAMClient() [1/3]

google::cloud::iam::IAMClient::IAMClient ( std::shared_ptr< IAMConnection connection,
Options  opts = {} 
)
explicit

◆ ~IAMClient()

google::cloud::iam::IAMClient::~IAMClient ( )

◆ IAMClient() [2/3]

google::cloud::iam::IAMClient::IAMClient ( IAMClient const &  )
default

◆ IAMClient() [3/3]

google::cloud::iam::IAMClient::IAMClient ( IAMClient &&  )
default

Member Function Documentation

◆ CreateRole()

StatusOr<google::iam::admin::v1::Role> google::cloud::iam::IAMClient::CreateRole ( google::iam::admin::v1::CreateRoleRequest const &  request,
Options  opts = {} 
)

Creates a new custom Role.

Parameters
requestgoogle::iam::admin::v1::CreateRoleRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::admin::v1::Role

◆ CreateServiceAccount() [1/2]

StatusOr<google::iam::admin::v1::ServiceAccount> google::cloud::iam::IAMClient::CreateServiceAccount ( google::iam::admin::v1::CreateServiceAccountRequest const &  request,
Options  opts = {} 
)

Creates a ServiceAccount.

Parameters
requestgoogle::iam::admin::v1::CreateServiceAccountRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::admin::v1::ServiceAccount

◆ CreateServiceAccount() [2/2]

StatusOr<google::iam::admin::v1::ServiceAccount> google::cloud::iam::IAMClient::CreateServiceAccount ( std::string const &  name,
std::string const &  account_id,
google::iam::admin::v1::ServiceAccount const &  service_account,
Options  opts = {} 
)

Creates a ServiceAccount.

Parameters
nameRequired. The resource name of the project associated with the service accounts, such as projects/my-project-123.
account_idRequired. The account id that is used to generate the service account email address and a stable unique id. It is unique within a project, must be 6-30 characters long, and match the regular expression [a-z]([-a-z0-9]*[a-z0-9]) to comply with RFC1035.
service_accountThe ServiceAccount resource to create. Currently, only the following values are user assignable: display_name and description.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::admin::v1::ServiceAccount

◆ CreateServiceAccountKey() [1/2]

StatusOr<google::iam::admin::v1::ServiceAccountKey> google::cloud::iam::IAMClient::CreateServiceAccountKey ( google::iam::admin::v1::CreateServiceAccountKeyRequest const &  request,
Options  opts = {} 
)

Creates a ServiceAccountKey.

Parameters
requestgoogle::iam::admin::v1::CreateServiceAccountKeyRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::admin::v1::ServiceAccountKey

◆ CreateServiceAccountKey() [2/2]

StatusOr<google::iam::admin::v1::ServiceAccountKey> google::cloud::iam::IAMClient::CreateServiceAccountKey ( std::string const &  name,
google::iam::admin::v1::ServiceAccountPrivateKeyType  private_key_type,
google::iam::admin::v1::ServiceAccountKeyAlgorithm  key_algorithm,
Options  opts = {} 
)

Creates a ServiceAccountKey.

Parameters
nameRequired. The resource name of the service account in the following format: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. Using - as a wildcard for the PROJECT_ID will infer the project from the account. The ACCOUNT value can be the email address or the unique_id of the service account.
private_key_typeThe output format of the private key. The default value is TYPE_GOOGLE_CREDENTIALS_FILE, which is the Google Credentials File format.
key_algorithmWhich type of key and algorithm to use for the key. The default is currently a 2K RSA key. However this may change in the future.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::admin::v1::ServiceAccountKey

◆ DeleteRole()

StatusOr<google::iam::admin::v1::Role> google::cloud::iam::IAMClient::DeleteRole ( google::iam::admin::v1::DeleteRoleRequest const &  request,
Options  opts = {} 
)

Deletes a custom Role.

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

  • You cannot bind a member 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
requestgoogle::iam::admin::v1::DeleteRoleRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::admin::v1::Role

◆ DeleteServiceAccount() [1/2]

Status google::cloud::iam::IAMClient::DeleteServiceAccount ( google::iam::admin::v1::DeleteServiceAccountRequest const &  request,
Options  opts = {} 
)

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
requestgoogle::iam::admin::v1::DeleteServiceAccountRequest
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ DeleteServiceAccount() [2/2]

Status google::cloud::iam::IAMClient::DeleteServiceAccount ( std::string const &  name,
Options  opts = {} 
)

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
nameRequired. The resource name of the service account in the following format: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. Using - as a wildcard for the PROJECT_ID will infer the project from the account. The ACCOUNT value can be the email address or the unique_id of the service account.
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ DeleteServiceAccountKey() [1/2]

Status google::cloud::iam::IAMClient::DeleteServiceAccountKey ( google::iam::admin::v1::DeleteServiceAccountKeyRequest const &  request,
Options  opts = {} 
)

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
requestgoogle::iam::admin::v1::DeleteServiceAccountKeyRequest
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ DeleteServiceAccountKey() [2/2]

Status google::cloud::iam::IAMClient::DeleteServiceAccountKey ( std::string const &  name,
Options  opts = {} 
)

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
nameRequired. The resource name of the service account key in the following format: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}. Using - as a wildcard for the PROJECT_ID will infer the project from the account. The ACCOUNT value can be the email address or the unique_id of the service account.
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ DisableServiceAccount()

Status google::cloud::iam::IAMClient::DisableServiceAccount ( google::iam::admin::v1::DisableServiceAccountRequest const &  request,
Options  opts = {} 
)

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
requestgoogle::iam::admin::v1::DisableServiceAccountRequest
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ EnableServiceAccount()

Status google::cloud::iam::IAMClient::EnableServiceAccount ( google::iam::admin::v1::EnableServiceAccountRequest const &  request,
Options  opts = {} 
)

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
requestgoogle::iam::admin::v1::EnableServiceAccountRequest
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ GetIamPolicy() [1/2]

StatusOr<google::iam::v1::Policy> google::cloud::iam::IAMClient::GetIamPolicy ( google::iam::v1::GetIamPolicyRequest const &  request,
Options  opts = {} 
)

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

This IAM policy specifies which members 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
requestgoogle::iam::v1::GetIamPolicyRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::v1::Policy

◆ GetIamPolicy() [2/2]

StatusOr<google::iam::v1::Policy> google::cloud::iam::IAMClient::GetIamPolicy ( std::string const &  resource,
Options  opts = {} 
)

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

This IAM policy specifies which members 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
resourceREQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::v1::Policy

◆ GetRole()

StatusOr<google::iam::admin::v1::Role> google::cloud::iam::IAMClient::GetRole ( google::iam::admin::v1::GetRoleRequest const &  request,
Options  opts = {} 
)

Gets the definition of a Role.

Parameters
requestgoogle::iam::admin::v1::GetRoleRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::admin::v1::Role

◆ GetServiceAccount() [1/2]

StatusOr<google::iam::admin::v1::ServiceAccount> google::cloud::iam::IAMClient::GetServiceAccount ( google::iam::admin::v1::GetServiceAccountRequest const &  request,
Options  opts = {} 
)

Gets a ServiceAccount.

Parameters
requestgoogle::iam::admin::v1::GetServiceAccountRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::admin::v1::ServiceAccount

◆ GetServiceAccount() [2/2]

StatusOr<google::iam::admin::v1::ServiceAccount> google::cloud::iam::IAMClient::GetServiceAccount ( std::string const &  name,
Options  opts = {} 
)

Gets a ServiceAccount.

Parameters
nameRequired. The resource name of the service account in the following format: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. Using - as a wildcard for the PROJECT_ID will infer the project from the account. The ACCOUNT value can be the email address or the unique_id of the service account.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::admin::v1::ServiceAccount

◆ GetServiceAccountKey() [1/2]

StatusOr<google::iam::admin::v1::ServiceAccountKey> google::cloud::iam::IAMClient::GetServiceAccountKey ( google::iam::admin::v1::GetServiceAccountKeyRequest const &  request,
Options  opts = {} 
)

Gets a ServiceAccountKey.

Parameters
requestgoogle::iam::admin::v1::GetServiceAccountKeyRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::admin::v1::ServiceAccountKey

◆ GetServiceAccountKey() [2/2]

StatusOr<google::iam::admin::v1::ServiceAccountKey> google::cloud::iam::IAMClient::GetServiceAccountKey ( std::string const &  name,
google::iam::admin::v1::ServiceAccountPublicKeyType  public_key_type,
Options  opts = {} 
)

Gets a ServiceAccountKey.

Parameters
nameRequired. The resource name of the service account key in the following format: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}. Using - as a wildcard for the PROJECT_ID will infer the project from the account. The ACCOUNT value can be the email address or the unique_id of the service account.
public_key_typeThe output format of the public key requested. X509_PEM is the default output format.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::admin::v1::ServiceAccountKey

◆ LintPolicy()

StatusOr<google::iam::admin::v1::LintPolicyResponse> google::cloud::iam::IAMClient::LintPolicy ( google::iam::admin::v1::LintPolicyRequest const &  request,
Options  opts = {} 
)

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
requestgoogle::iam::admin::v1::LintPolicyRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::admin::v1::LintPolicyResponse

◆ ListRoles()

StreamRange<google::iam::admin::v1::Role> google::cloud::iam::IAMClient::ListRoles ( google::iam::admin::v1::ListRolesRequest  request,
Options  opts = {} 
)

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

Parameters
requestgoogle::iam::admin::v1::ListRolesRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::admin::v1::Role

◆ ListServiceAccountKeys() [1/2]

StatusOr<google::iam::admin::v1::ListServiceAccountKeysResponse> google::cloud::iam::IAMClient::ListServiceAccountKeys ( google::iam::admin::v1::ListServiceAccountKeysRequest const &  request,
Options  opts = {} 
)

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

Parameters
requestgoogle::iam::admin::v1::ListServiceAccountKeysRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::admin::v1::ListServiceAccountKeysResponse

◆ ListServiceAccountKeys() [2/2]

StatusOr<google::iam::admin::v1::ListServiceAccountKeysResponse> google::cloud::iam::IAMClient::ListServiceAccountKeys ( std::string const &  name,
std::vector< google::iam::admin::v1::ListServiceAccountKeysRequest::KeyType > const &  key_types,
Options  opts = {} 
)

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

Parameters
nameRequired. The resource name of the service account in the following format: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. Using - as a wildcard for the PROJECT_ID, will infer the project from the account. The ACCOUNT value can be the email address or the unique_id of the service account.
key_typesFilters the types of keys the user wants to include in the list response. Duplicate key types are not allowed. If no key type is provided, all keys are returned.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::admin::v1::ListServiceAccountKeysResponse

◆ ListServiceAccounts() [1/2]

StreamRange<google::iam::admin::v1::ServiceAccount> google::cloud::iam::IAMClient::ListServiceAccounts ( google::iam::admin::v1::ListServiceAccountsRequest  request,
Options  opts = {} 
)

Lists every ServiceAccount that belongs to a specific project.

Parameters
requestgoogle::iam::admin::v1::ListServiceAccountsRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::admin::v1::ServiceAccount

◆ ListServiceAccounts() [2/2]

StreamRange<google::iam::admin::v1::ServiceAccount> google::cloud::iam::IAMClient::ListServiceAccounts ( std::string const &  name,
Options  opts = {} 
)

Lists every ServiceAccount that belongs to a specific project.

Parameters
nameRequired. The resource name of the project associated with the service accounts, such as projects/my-project-123.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::admin::v1::ServiceAccount

◆ operator=() [1/2]

IAMClient& google::cloud::iam::IAMClient::operator= ( IAMClient &&  )
default

◆ operator=() [2/2]

IAMClient& google::cloud::iam::IAMClient::operator= ( IAMClient const &  )
default

◆ PatchServiceAccount()

StatusOr<google::iam::admin::v1::ServiceAccount> google::cloud::iam::IAMClient::PatchServiceAccount ( google::iam::admin::v1::PatchServiceAccountRequest const &  request,
Options  opts = {} 
)

Patches a ServiceAccount.

Parameters
requestgoogle::iam::admin::v1::PatchServiceAccountRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::admin::v1::ServiceAccount

◆ QueryAuditableServices()

StatusOr<google::iam::admin::v1::QueryAuditableServicesResponse> google::cloud::iam::IAMClient::QueryAuditableServices ( google::iam::admin::v1::QueryAuditableServicesRequest const &  request,
Options  opts = {} 
)

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
requestgoogle::iam::admin::v1::QueryAuditableServicesRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::admin::v1::QueryAuditableServicesResponse

◆ QueryGrantableRoles() [1/2]

StreamRange<google::iam::admin::v1::Role> google::cloud::iam::IAMClient::QueryGrantableRoles ( google::iam::admin::v1::QueryGrantableRolesRequest  request,
Options  opts = {} 
)

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
requestgoogle::iam::admin::v1::QueryGrantableRolesRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::admin::v1::Role

◆ QueryGrantableRoles() [2/2]

StreamRange<google::iam::admin::v1::Role> google::cloud::iam::IAMClient::QueryGrantableRoles ( std::string const &  full_resource_name,
Options  opts = {} 
)

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
full_resource_nameRequired. The full resource name to query from the list of grantable roles. The name follows the Google Cloud Platform resource format. For example, a Cloud Platform project with id my-project will be named //cloudresourcemanager.googleapis.com/projects/my-project.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::admin::v1::Role

◆ QueryTestablePermissions()

StreamRange<google::iam::admin::v1::Permission> google::cloud::iam::IAMClient::QueryTestablePermissions ( google::iam::admin::v1::QueryTestablePermissionsRequest  request,
Options  opts = {} 
)

Lists every permission that you can test on a resource.

A permission is testable if you can check whether a member has that permission on the resource.

Parameters
requestgoogle::iam::admin::v1::QueryTestablePermissionsRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::admin::v1::Permission

◆ SetIamPolicy() [1/3]

StatusOr<google::iam::v1::Policy> google::cloud::iam::IAMClient::SetIamPolicy ( google::iam::v1::SetIamPolicyRequest const &  request,
Options  opts = {} 
)

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 member 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 Granting roles to a service account for specific resources.

Parameters
requestgoogle::iam::v1::SetIamPolicyRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::v1::Policy

◆ SetIamPolicy() [2/3]

StatusOr<google::iam::v1::Policy> google::cloud::iam::IAMClient::SetIamPolicy ( std::string const &  resource,
google::iam::v1::Policy const &  policy,
Options  opts = {} 
)

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 member 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 Granting roles to a service account for specific resources.

Parameters
resourceREQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
policyREQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::v1::Policy

◆ SetIamPolicy() [3/3]

StatusOr<google::iam::v1::Policy> google::cloud::iam::IAMClient::SetIamPolicy ( std::string const &  resource,
IamUpdater const &  updater,
Options  opts = {} 
)

Updates the IAM policy for resource using an optimistic concurrency control loop.

The loop fetches the current policy for resource, and passes it to updater, which should return the new policy. This new policy should use the current etag so that the read-modify-write cycle can detect races and rerun the update when there is a mismatch. If the new policy does not have an etag, the existing policy will be blindly overwritten. If updater does not yield a policy, the control loop is terminated and kCancelled is returned.

Parameters
resourceRequired. The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
updaterRequired. Functor to map the current policy to a new one.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::v1::Policy

◆ TestIamPermissions() [1/2]

StatusOr<google::iam::v1::TestIamPermissionsResponse> google::cloud::iam::IAMClient::TestIamPermissions ( google::iam::v1::TestIamPermissionsRequest const &  request,
Options  opts = {} 
)

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

Parameters
requestgoogle::iam::v1::TestIamPermissionsRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::v1::TestIamPermissionsResponse

◆ TestIamPermissions() [2/2]

StatusOr<google::iam::v1::TestIamPermissionsResponse> google::cloud::iam::IAMClient::TestIamPermissions ( std::string const &  resource,
std::vector< std::string > const &  permissions,
Options  opts = {} 
)

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

Parameters
resourceREQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
permissionsThe set of permissions to check for the resource. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::v1::TestIamPermissionsResponse

◆ UndeleteRole()

StatusOr<google::iam::admin::v1::Role> google::cloud::iam::IAMClient::UndeleteRole ( google::iam::admin::v1::UndeleteRoleRequest const &  request,
Options  opts = {} 
)

Undeletes a custom Role.

Parameters
requestgoogle::iam::admin::v1::UndeleteRoleRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::admin::v1::Role

◆ UndeleteServiceAccount()

StatusOr<google::iam::admin::v1::UndeleteServiceAccountResponse> google::cloud::iam::IAMClient::UndeleteServiceAccount ( google::iam::admin::v1::UndeleteServiceAccountRequest const &  request,
Options  opts = {} 
)

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
requestgoogle::iam::admin::v1::UndeleteServiceAccountRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::admin::v1::UndeleteServiceAccountResponse

◆ UpdateRole()

StatusOr<google::iam::admin::v1::Role> google::cloud::iam::IAMClient::UpdateRole ( google::iam::admin::v1::UpdateRoleRequest const &  request,
Options  opts = {} 
)

Updates the definition of a custom Role.

Parameters
requestgoogle::iam::admin::v1::UpdateRoleRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::admin::v1::Role

◆ UploadServiceAccountKey()

StatusOr<google::iam::admin::v1::ServiceAccountKey> google::cloud::iam::IAMClient::UploadServiceAccountKey ( google::iam::admin::v1::UploadServiceAccountKeyRequest const &  request,
Options  opts = {} 
)

Creates a ServiceAccountKey, using a public key that you provide.

Parameters
requestgoogle::iam::admin::v1::UploadServiceAccountKeyRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::iam::admin::v1::ServiceAccountKey

Friends And Related Function Documentation

◆ operator!=

bool operator!= ( IAMClient const &  a,
IAMClient const &  b 
)
friend

Definition at line 99 of file iam_client.h.

◆ operator==

bool operator== ( IAMClient const &  a,
IAMClient const &  b 
)
friend

Definition at line 96 of file iam_client.h.