As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Managedidentities v1 API

class google.cloud.managedidentities_v1.types.AttachTrustRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [AttachTrust][google.cloud.managedidentities.v1.AttachTrust]

name

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

Type

str

trust

Required. The domain trust resource.

Type

google.cloud.managedidentities_v1.types.Trust

class google.cloud.managedidentities_v1.types.CreateMicrosoftAdDomainRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [CreateMicrosoftAdDomain][google.cloud.managedidentities.v1.CreateMicrosoftAdDomain]

parent

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

Type

str

domain_name

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.

Type

str

domain

Required. A Managed Identity domain resource.

Type

google.cloud.managedidentities_v1.types.Domain

class google.cloud.managedidentities_v1.types.DeleteDomainRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [DeleteDomain][google.cloud.managedidentities.v1.DeleteDomain]

name

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

Type

str

class google.cloud.managedidentities_v1.types.DetachTrustRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [DetachTrust][google.cloud.managedidentities.v1.DetachTrust]

name

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

Type

str

trust

Required. The domain trust resource to removed.

Type

google.cloud.managedidentities_v1.types.Trust

class google.cloud.managedidentities_v1.types.Domain(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a managed Microsoft Active Directory domain.

name

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

Type

str

labels

Optional. Resource labels that can contain user-provided metadata.

Type

MutableMapping[str, str]

authorized_networks

Optional. The full names of the Google Compute Engine networks the domain instance is connected to. Networks can be added using UpdateDomain. The domain is only available on networks listed in authorized_networks. If CIDR subnets overlap between networks, domain creation will fail.

Type

MutableSequence[str]

reserved_ip_range

Required. The CIDR range of internal addresses that are reserved for this domain. Reserved networks must be /24 or larger. Ranges must be unique and non-overlapping with existing subnets in [Domain].[authorized_networks].

Type

str

locations

Required. Locations where domain needs to be provisioned. [regions][compute/docs/regions-zones/] e.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each location will use a /26 block.

Type

MutableSequence[str]

admin

Optional. The name of delegated administrator account used to perform Active Directory operations. If not specified, setupadmin will be used.

Type

str

fqdn

Output only. The fully-qualified domain name of the exposed domain used by clients to connect to the service. Similar to what would be chosen for an Active Directory set up on an internal network.

Type

str

create_time

Output only. The time the instance was created.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. The last update time.

Type

google.protobuf.timestamp_pb2.Timestamp

state

Output only. The current state of this domain.

Type

google.cloud.managedidentities_v1.types.Domain.State

status_message

Output only. Additional information about the current status of this domain, if available.

Type

str

trusts

Output only. The current trusts associated with the domain.

Type

MutableSequence[google.cloud.managedidentities_v1.types.Trust]

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class State(value)

Bases: proto.enums.Enum

Represents the different states of a managed domain.

Values:

STATE_UNSPECIFIED (0):

Not set.

CREATING (1):

The domain is being created.

READY (2):

The domain has been created and is fully usable.

UPDATING (3):

The domain’s configuration is being updated.

DELETING (4):

The domain is being deleted.

REPAIRING (5):

The domain is being repaired and may be unusable. Details can be found in the status_message field.

PERFORMING_MAINTENANCE (6):

The domain is undergoing maintenance.

UNAVAILABLE (7):

The domain is not serving requests.

class google.cloud.managedidentities_v1.types.GetDomainRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [GetDomain][google.cloud.managedidentities.v1.GetDomain]

name

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

Type

str

class google.cloud.managedidentities_v1.types.ListDomainsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [ListDomains][google.cloud.managedidentities.v1.ListDomains]

parent

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

Type

str

page_size

Optional. The maximum number of items to return. If not specified, a default value of 1000 will be used. Regardless of the page_size value, the response may include a partial list. Callers should rely on a response’s [next_page_token][google.cloud.managedidentities.v1.ListDomainsResponse.next_page_token] to determine if there are additional results to list.

Type

int

page_token

Optional. The next_page_token value returned from a previous ListDomainsRequest request, if any.

Type

str

filter

Optional. A filter specifying constraints of a list operation. For example, Domain.fqdn="mydomain.myorginization".

Type

str

order_by

Optional. Specifies the ordering of results. See Sorting order for more information.

Type

str

class google.cloud.managedidentities_v1.types.ListDomainsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for [ListDomains][google.cloud.managedidentities.v1.ListDomains]

domains

A list of Managed Identities Service domains in the project.

Type

MutableSequence[google.cloud.managedidentities_v1.types.Domain]

next_page_token

A token to retrieve the next page of results, or empty if there are no more results in the list.

Type

str

unreachable

A list of locations that could not be reached.

Type

MutableSequence[str]

class google.cloud.managedidentities_v1.types.OpMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents the metadata of the long-running operation.

create_time

Output only. The time the operation was created.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

Output only. The time the operation finished running.

Type

google.protobuf.timestamp_pb2.Timestamp

target

Output only. Server-defined resource path for the target of the operation.

Type

str

verb

Output only. Name of the verb executed by the operation.

Type

str

requested_cancellation

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED.

Type

bool

api_version

Output only. API version used to start the operation.

Type

str

class google.cloud.managedidentities_v1.types.ReconfigureTrustRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [ReconfigureTrust][google.cloud.managedidentities.v1.ReconfigureTrust]

name

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

Type

str

target_domain_name

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

Type

str

target_dns_ip_addresses

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

Type

MutableSequence[str]

class google.cloud.managedidentities_v1.types.ResetAdminPasswordRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [ResetAdminPassword][google.cloud.managedidentities.v1.ResetAdminPassword]

name

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

Type

str

class google.cloud.managedidentities_v1.types.ResetAdminPasswordResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for [ResetAdminPassword][google.cloud.managedidentities.v1.ResetAdminPassword]

password

A random password. See [admin][google.cloud.managedidentities.v1.Domain.admin] for more information.

Type

str

class google.cloud.managedidentities_v1.types.Trust(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a relationship between two domains. This allows a controller in one domain to authenticate a user in another domain.

target_domain_name

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

Type

str

trust_type

Required. The type of trust represented by the trust resource.

Type

google.cloud.managedidentities_v1.types.Trust.TrustType

trust_direction

Required. The trust direction, which decides if the current domain is trusted, trusting, or both.

Type

google.cloud.managedidentities_v1.types.Trust.TrustDirection

selective_authentication

Optional. The trust authentication type, which decides whether the trusted side has forest/domain wide access or selective access to an approved set of resources.

Type

bool

target_dns_ip_addresses

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

Type

MutableSequence[str]

trust_handshake_secret

Required. The trust secret used for the handshake with the target domain. This will not be stored.

Type

str

create_time

Output only. The time the instance was created.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. The last update time.

Type

google.protobuf.timestamp_pb2.Timestamp

state

Output only. The current state of the trust.

Type

google.cloud.managedidentities_v1.types.Trust.State

state_description

Output only. Additional information about the current state of the trust, if available.

Type

str

last_trust_heartbeat_time

Output only. The last heartbeat time when the trust was known to be connected.

Type

google.protobuf.timestamp_pb2.Timestamp

class State(value)

Bases: proto.enums.Enum

Represents the different states of a domain trust.

Values:

STATE_UNSPECIFIED (0):

Not set.

CREATING (1):

The domain trust is being created.

UPDATING (2):

The domain trust is being updated.

DELETING (3):

The domain trust is being deleted.

CONNECTED (4):

The domain trust is connected.

DISCONNECTED (5):

The domain trust is disconnected.

class TrustDirection(value)

Bases: proto.enums.Enum

Represents the direction of trust. See System.DirectoryServices.ActiveDirectory.TrustDirection for more information.

Values:

TRUST_DIRECTION_UNSPECIFIED (0):

Not set.

INBOUND (1):

The inbound direction represents the trusting side.

OUTBOUND (2):

The outboud direction represents the trusted side.

BIDIRECTIONAL (3):

The bidirectional direction represents the trusted / trusting side.

class TrustType(value)

Bases: proto.enums.Enum

Represents the different inter-forest trust types.

Values:

TRUST_TYPE_UNSPECIFIED (0):

Not set.

FOREST (1):

The forest trust.

EXTERNAL (2):

The external domain trust.

class google.cloud.managedidentities_v1.types.UpdateDomainRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [UpdateDomain][google.cloud.managedidentities.v1.UpdateDomain]

update_mask

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][google.cloud.managedidentities.v1.Domain]:

• labels

• locations

• authorized_networks

Type

google.protobuf.field_mask_pb2.FieldMask

domain

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

Type

google.cloud.managedidentities_v1.types.Domain

class google.cloud.managedidentities_v1.types.ValidateTrustRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for [ValidateTrust][google.cloud.managedidentities.v1.ValidateTrust]

name

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

Type

str

trust

Required. The domain trust to validate trust state for.

Type

google.cloud.managedidentities_v1.types.Trust