- 1.46.0 (latest)
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.6
- 1.0.5
- 0.3.7
The interfaces provided are listed below, along with usage samples.
ManagedIdentitiesServiceClient
Service Description: 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.
Sample for ManagedIdentitiesServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
DomainName name = DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]");
ResetAdminPasswordResponse response = managedIdentitiesServiceClient.resetAdminPassword(name);
}
Classes
AttachTrustRequest
Request message for AttachTrust
Protobuf type google.cloud.managedidentities.v1.AttachTrustRequest
AttachTrustRequest.Builder
Request message for AttachTrust
Protobuf type google.cloud.managedidentities.v1.AttachTrustRequest
CreateMicrosoftAdDomainRequest
Request message for CreateMicrosoftAdDomain
Protobuf type google.cloud.managedidentities.v1.CreateMicrosoftAdDomainRequest
CreateMicrosoftAdDomainRequest.Builder
Request message for CreateMicrosoftAdDomain
Protobuf type google.cloud.managedidentities.v1.CreateMicrosoftAdDomainRequest
DeleteDomainRequest
Request message for DeleteDomain
Protobuf type google.cloud.managedidentities.v1.DeleteDomainRequest
DeleteDomainRequest.Builder
Request message for DeleteDomain
Protobuf type google.cloud.managedidentities.v1.DeleteDomainRequest
DetachTrustRequest
Request message for DetachTrust
Protobuf type google.cloud.managedidentities.v1.DetachTrustRequest
DetachTrustRequest.Builder
Request message for DetachTrust
Protobuf type google.cloud.managedidentities.v1.DetachTrustRequest
Domain
Represents a managed Microsoft Active Directory domain.
Protobuf type google.cloud.managedidentities.v1.Domain
Domain.Builder
Represents a managed Microsoft Active Directory domain.
Protobuf type google.cloud.managedidentities.v1.Domain
DomainName
DomainName.Builder
Builder for projects/{project}/locations/{location}/domains/{domain}.
GetDomainRequest
Request message for GetDomain
Protobuf type google.cloud.managedidentities.v1.GetDomainRequest
GetDomainRequest.Builder
Request message for GetDomain
Protobuf type google.cloud.managedidentities.v1.GetDomainRequest
ListDomainsRequest
Request message for ListDomains
Protobuf type google.cloud.managedidentities.v1.ListDomainsRequest
ListDomainsRequest.Builder
Request message for ListDomains
Protobuf type google.cloud.managedidentities.v1.ListDomainsRequest
ListDomainsResponse
Response message for ListDomains
Protobuf type google.cloud.managedidentities.v1.ListDomainsResponse
ListDomainsResponse.Builder
Response message for ListDomains
Protobuf type google.cloud.managedidentities.v1.ListDomainsResponse
LocationName
LocationName.Builder
Builder for projects/{project}/locations/{location}.
ManagedIdentitiesServiceClient
Service Description: 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.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create()) {
DomainName name = DomainName.of("[PROJECT]", "[LOCATION]", "[DOMAIN]");
ResetAdminPasswordResponse response = managedIdentitiesServiceClient.resetAdminPassword(name);
}
Note: close() needs to be called on the ManagedIdentitiesServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of ManagedIdentitiesServiceSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ManagedIdentitiesServiceSettings managedIdentitiesServiceSettings =
ManagedIdentitiesServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create(managedIdentitiesServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ManagedIdentitiesServiceSettings managedIdentitiesServiceSettings =
ManagedIdentitiesServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
ManagedIdentitiesServiceClient managedIdentitiesServiceClient =
ManagedIdentitiesServiceClient.create(managedIdentitiesServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
ManagedIdentitiesServiceClient.ListDomainsFixedSizeCollection
ManagedIdentitiesServiceClient.ListDomainsPage
ManagedIdentitiesServiceClient.ListDomainsPagedResponse
ManagedIdentitiesServiceGrpc
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.
ManagedIdentitiesServiceGrpc.ManagedIdentitiesServiceBlockingStub
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.
ManagedIdentitiesServiceGrpc.ManagedIdentitiesServiceFutureStub
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.
ManagedIdentitiesServiceGrpc.ManagedIdentitiesServiceImplBase
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.
ManagedIdentitiesServiceGrpc.ManagedIdentitiesServiceStub
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.
ManagedIdentitiesServiceProto
ManagedIdentitiesServiceSettings
Settings class to configure an instance of ManagedIdentitiesServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (managedidentities.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of resetAdminPassword to 30 seconds:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ManagedIdentitiesServiceSettings.Builder managedIdentitiesServiceSettingsBuilder =
ManagedIdentitiesServiceSettings.newBuilder();
managedIdentitiesServiceSettingsBuilder
.resetAdminPasswordSettings()
.setRetrySettings(
managedIdentitiesServiceSettingsBuilder
.resetAdminPasswordSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
ManagedIdentitiesServiceSettings managedIdentitiesServiceSettings =
managedIdentitiesServiceSettingsBuilder.build();
ManagedIdentitiesServiceSettings.Builder
Builder for ManagedIdentitiesServiceSettings.
OpMetadata
Represents the metadata of the long-running operation.
Protobuf type google.cloud.managedidentities.v1.OpMetadata
OpMetadata.Builder
Represents the metadata of the long-running operation.
Protobuf type google.cloud.managedidentities.v1.OpMetadata
ReconfigureTrustRequest
Request message for ReconfigureTrust
Protobuf type google.cloud.managedidentities.v1.ReconfigureTrustRequest
ReconfigureTrustRequest.Builder
Request message for ReconfigureTrust
Protobuf type google.cloud.managedidentities.v1.ReconfigureTrustRequest
ResetAdminPasswordRequest
Request message for ResetAdminPassword
Protobuf type google.cloud.managedidentities.v1.ResetAdminPasswordRequest
ResetAdminPasswordRequest.Builder
Request message for ResetAdminPassword
Protobuf type google.cloud.managedidentities.v1.ResetAdminPasswordRequest
ResetAdminPasswordResponse
Response message for ResetAdminPassword
Protobuf type google.cloud.managedidentities.v1.ResetAdminPasswordResponse
ResetAdminPasswordResponse.Builder
Response message for ResetAdminPassword
Protobuf type google.cloud.managedidentities.v1.ResetAdminPasswordResponse
ResourceProto
Trust
Represents a relationship between two domains. This allows a controller in one domain to authenticate a user in another domain.
Protobuf type google.cloud.managedidentities.v1.Trust
Trust.Builder
Represents a relationship between two domains. This allows a controller in one domain to authenticate a user in another domain.
Protobuf type google.cloud.managedidentities.v1.Trust
UpdateDomainRequest
Request message for UpdateDomain
Protobuf type google.cloud.managedidentities.v1.UpdateDomainRequest
UpdateDomainRequest.Builder
Request message for UpdateDomain
Protobuf type google.cloud.managedidentities.v1.UpdateDomainRequest
ValidateTrustRequest
Request message for ValidateTrust
Protobuf type google.cloud.managedidentities.v1.ValidateTrustRequest
ValidateTrustRequest.Builder
Request message for ValidateTrust
Protobuf type google.cloud.managedidentities.v1.ValidateTrustRequest
Interfaces
AttachTrustRequestOrBuilder
CreateMicrosoftAdDomainRequestOrBuilder
DeleteDomainRequestOrBuilder
DetachTrustRequestOrBuilder
DomainOrBuilder
GetDomainRequestOrBuilder
ListDomainsRequestOrBuilder
ListDomainsResponseOrBuilder
OpMetadataOrBuilder
ReconfigureTrustRequestOrBuilder
ResetAdminPasswordRequestOrBuilder
ResetAdminPasswordResponseOrBuilder
TrustOrBuilder
UpdateDomainRequestOrBuilder
ValidateTrustRequestOrBuilder
Enums
Domain.State
Represents the different states of a managed domain.
Protobuf enum google.cloud.managedidentities.v1.Domain.State
Trust.State
Represents the different states of a domain trust.
Protobuf enum google.cloud.managedidentities.v1.Trust.State
Trust.TrustDirection
Represents the direction of trust. See System.DirectoryServices.ActiveDirectory.TrustDirection for more information.
Protobuf enum google.cloud.managedidentities.v1.Trust.TrustDirection
Trust.TrustType
Represents the different inter-forest trust types.
Protobuf enum google.cloud.managedidentities.v1.Trust.TrustType