Class ManagedIdentitiesServiceClient (2.21.0)

API Overview.

The managedidentites.googleapis.com service implements the Google Cloud Managed Identites API for identity services (e.g. Microsoft Active Directory).

The Managed Identities service provides methods to manage (create/read/update/delete) domains, reset managed identities admin password, add/remove domain controllers in GCP regions and add/remove VPC peering.

Data Model

The Managed Identities service exposes the following resources:

  • Locations as global, named as follows: projects/{project_id}/locations/global.
  • Domains, named as follows: /projects/{project_id}/locations/global/domain/{domain_name}.

The {domain_name} refers to fully qualified domain name in the customer project e.g. mydomain.myorganization.com, with the following restrictions:

  • Must contain only lowercase letters, numbers, periods and hyphens.
  • Must start with a letter.
  • Must contain between 2-64 characters.
  • Must end with a number or a letter.
  • Must not start with period.
  • First segement length (mydomain form example above) shouldn't exceed 15 chars.
  • The last segment cannot be fully numeric.
  • Must be unique within the customer project.
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.

Constructors

ManagedIdentitiesServiceClient(ManagedIdentitiesServiceClient const &)

Copy and move support

Parameter
NameDescription
ManagedIdentitiesServiceClient const &

ManagedIdentitiesServiceClient(ManagedIdentitiesServiceClient &&)

Copy and move support

Parameter
NameDescription
ManagedIdentitiesServiceClient &&

ManagedIdentitiesServiceClient(std::shared_ptr< ManagedIdentitiesServiceConnection >, Options)

Parameters
NameDescription
connection std::shared_ptr< ManagedIdentitiesServiceConnection >
opts Options

Operators

operator=(ManagedIdentitiesServiceClient const &)

Copy and move support

Parameter
NameDescription
ManagedIdentitiesServiceClient const &
Returns
TypeDescription
ManagedIdentitiesServiceClient &

operator=(ManagedIdentitiesServiceClient &&)

Copy and move support

Parameter
NameDescription
ManagedIdentitiesServiceClient &&
Returns
TypeDescription
ManagedIdentitiesServiceClient &

Functions

CreateMicrosoftAdDomain(std::string const &, std::string const &, google::cloud::managedidentities::v1::Domain const &, Options)

Creates a Microsoft AD domain.

Parameters
NameDescription
parent std::string const &

Required. The resource project name and location using the form: projects/{project_id}/locations/global

domain_name std::string const &

Required. The fully qualified domain name. e.g. mydomain.myorganization.com, with the following restrictions:

  • Must contain only lowercase letters, numbers, periods and hyphens.
  • Must start with a letter.
  • Must contain between 2-64 characters.
  • Must end with a number or a letter.
  • Must not start with period.
  • First segement length (mydomain form example above) shouldn't exceed 15 chars.
  • The last segment cannot be fully numeric.
  • Must be unique within the customer project.
domain google::cloud::managedidentities::v1::Domain const &

Required. A Managed Identity domain resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::managedidentities::v1::Domain > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.managedidentities.v1.Domain proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateMicrosoftAdDomain(google::cloud::managedidentities::v1::CreateMicrosoftAdDomainRequest const &, Options)

Creates a Microsoft AD domain.

Parameters
NameDescription
request google::cloud::managedidentities::v1::CreateMicrosoftAdDomainRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.managedidentities.v1.CreateMicrosoftAdDomainRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::managedidentities::v1::Domain > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.managedidentities.v1.Domain proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ResetAdminPassword(std::string const &, Options)

Resets a domain's administrator password.

Parameters
NameDescription
name std::string const &

Required. The domain resource name using the form: projects/{project_id}/locations/global/domains/{domain_name}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::managedidentities::v1::ResetAdminPasswordResponse >

the result of the RPC. The response message type (google.cloud.managedidentities.v1.ResetAdminPasswordResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ResetAdminPassword(google::cloud::managedidentities::v1::ResetAdminPasswordRequest const &, Options)

Resets a domain's administrator password.

Parameters
NameDescription
request google::cloud::managedidentities::v1::ResetAdminPasswordRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.managedidentities.v1.ResetAdminPasswordRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::managedidentities::v1::ResetAdminPasswordResponse >

the result of the RPC. The response message type (google.cloud.managedidentities.v1.ResetAdminPasswordResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListDomains(std::string const &, Options)

Lists domains in a project.

Parameters
NameDescription
parent std::string const &

Required. The resource name of the domain location using the form: projects/{project_id}/locations/global

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StreamRange< google::cloud::managedidentities::v1::Domain >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.managedidentities.v1.Domain, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDomains(google::cloud::managedidentities::v1::ListDomainsRequest, Options)

Lists domains in a project.

Parameters
NameDescription
request google::cloud::managedidentities::v1::ListDomainsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.managedidentities.v1.ListDomainsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StreamRange< google::cloud::managedidentities::v1::Domain >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.managedidentities.v1.Domain, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetDomain(std::string const &, Options)

Gets information about a domain.

Parameters
NameDescription
name std::string const &

Required. The domain resource name using the form: projects/{project_id}/locations/global/domains/{domain_name}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::managedidentities::v1::Domain >

the result of the RPC. The response message type (google.cloud.managedidentities.v1.Domain) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetDomain(google::cloud::managedidentities::v1::GetDomainRequest const &, Options)

Gets information about a domain.

Parameters
NameDescription
request google::cloud::managedidentities::v1::GetDomainRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.managedidentities.v1.GetDomainRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::managedidentities::v1::Domain >

the result of the RPC. The response message type (google.cloud.managedidentities.v1.Domain) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateDomain(google::cloud::managedidentities::v1::Domain const &, google::protobuf::FieldMask const &, Options)

Updates the metadata and configuration of a domain.

Parameters
NameDescription
domain google::cloud::managedidentities::v1::Domain const &

Required. Domain message with updated fields. Only supported fields specified in update_mask are updated.

update_mask google::protobuf::FieldMask const &

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include fields from Domain:

  • labels
  • locations
  • authorized_networks
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::managedidentities::v1::Domain > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.managedidentities.v1.Domain proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateDomain(google::cloud::managedidentities::v1::UpdateDomainRequest const &, Options)

Updates the metadata and configuration of a domain.

Parameters
NameDescription
request google::cloud::managedidentities::v1::UpdateDomainRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.managedidentities.v1.UpdateDomainRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::managedidentities::v1::Domain > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.managedidentities.v1.Domain proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteDomain(std::string const &, Options)

Deletes a domain.

Parameters
NameDescription
name std::string const &

Required. The domain resource name using the form: projects/{project_id}/locations/global/domains/{domain_name}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::managedidentities::v1::OpMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.managedidentities.v1.OpMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteDomain(google::cloud::managedidentities::v1::DeleteDomainRequest const &, Options)

Deletes a domain.

Parameters
NameDescription
request google::cloud::managedidentities::v1::DeleteDomainRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.managedidentities.v1.DeleteDomainRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::managedidentities::v1::OpMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.managedidentities.v1.OpMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

AttachTrust(std::string const &, google::cloud::managedidentities::v1::Trust const &, Options)

Adds an AD trust to a domain.

Parameters
NameDescription
name std::string const &

Required. The resource domain name, project name and location using the form: projects/{project_id}/locations/global/domains/{domain_name}

trust google::cloud::managedidentities::v1::Trust const &

Required. The domain trust resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::managedidentities::v1::Domain > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.managedidentities.v1.Domain proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

AttachTrust(google::cloud::managedidentities::v1::AttachTrustRequest const &, Options)

Adds an AD trust to a domain.

Parameters
NameDescription
request google::cloud::managedidentities::v1::AttachTrustRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.managedidentities.v1.AttachTrustRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::managedidentities::v1::Domain > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.managedidentities.v1.Domain proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ReconfigureTrust(std::string const &, std::string const &, std::vector< std::string > const &, Options)

Updates the DNS conditional forwarder.

Parameters
NameDescription
name std::string const &

Required. The resource domain name, project name and location using the form: projects/{project_id}/locations/global/domains/{domain_name}

target_domain_name std::string const &

Required. The fully-qualified target domain name which will be in trust with current domain.

target_dns_ip_addresses std::vector< std::string > const &

Required. The target DNS server IP addresses to resolve the remote domain involved in the trust.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::managedidentities::v1::Domain > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.managedidentities.v1.Domain proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ReconfigureTrust(google::cloud::managedidentities::v1::ReconfigureTrustRequest const &, Options)

Updates the DNS conditional forwarder.

Parameters
NameDescription
request google::cloud::managedidentities::v1::ReconfigureTrustRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.managedidentities.v1.ReconfigureTrustRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::managedidentities::v1::Domain > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.managedidentities.v1.Domain proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DetachTrust(std::string const &, google::cloud::managedidentities::v1::Trust const &, Options)

Removes an AD trust.

Parameters
NameDescription
name std::string const &

Required. The resource domain name, project name, and location using the form: projects/{project_id}/locations/global/domains/{domain_name}

trust google::cloud::managedidentities::v1::Trust const &

Required. The domain trust resource to removed.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::managedidentities::v1::Domain > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.managedidentities.v1.Domain proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DetachTrust(google::cloud::managedidentities::v1::DetachTrustRequest const &, Options)

Removes an AD trust.

Parameters
NameDescription
request google::cloud::managedidentities::v1::DetachTrustRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.managedidentities.v1.DetachTrustRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::managedidentities::v1::Domain > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.managedidentities.v1.Domain proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ValidateTrust(std::string const &, google::cloud::managedidentities::v1::Trust const &, Options)

Validates a trust state, that the target domain is reachable, and that the target domain is able to accept incoming trust requests.

Parameters
NameDescription
name std::string const &

Required. The resource domain name, project name, and location using the form: projects/{project_id}/locations/global/domains/{domain_name}

trust google::cloud::managedidentities::v1::Trust const &

Required. The domain trust to validate trust state for.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::managedidentities::v1::Domain > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.managedidentities.v1.Domain proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ValidateTrust(google::cloud::managedidentities::v1::ValidateTrustRequest const &, Options)

Validates a trust state, that the target domain is reachable, and that the target domain is able to accept incoming trust requests.

Parameters
NameDescription
request google::cloud::managedidentities::v1::ValidateTrustRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.managedidentities.v1.ValidateTrustRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::managedidentities::v1::Domain > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.managedidentities.v1.Domain proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.