v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-134680139.0 KB
projects

CreateActiveDirectory Creates the active directory specified in the request.

post/v1/{+parent}/activeDirectories

Path parameters

parentstring required

Required. Value for parent.

Query parameters

activeDirectoryIdstring

Required. ID of the active directory to create. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter , the last a letter or a number, and a 63 character maximum.

Request body

nfsUsersWithLdapboolean

If enabled, will allow access to local users and LDAP users. If access is needed for only LDAP users, it has to be disabled.

encryptDcConnectionsboolean

If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.

backupOperatorsstring[]

Optional. Users to be added to the Built-in Backup Operator active directory group.

state'STATE_UNSPECIFIED' | 'CREATING' | 'READY' | 'UPDATING' | 'IN_USE' | 'DELETING' | 'ERROR' | 'DIAGNOSING'

Output only. The state of the AD.

organizationalUnitstring

The Organizational Unit (OU) within the Windows Active Directory the user belongs to.

aesEncryptionboolean

If enabled, AES encryption will be enabled for SMB communication.

kdcIpstring

KDC server IP address for the active directory machine.

createTimestring google-datetime

Output only. Create time of the active directory.

passwordstring

Required. Password of the Active Directory domain administrator.

stateDetailsstring

Output only. The state details of the Active Directory.

domainstring

Required. Name of the Active Directory domain

dnsstring

Required. Comma separated list of DNS server IP addresses for the Active Directory domain.

kdcHostnamestring

Name of the active directory machine. This optional parameter is used only while creating kerberos volume

namestring

Identifier. The resource name of the active directory. Format: projects/{project_number}/locations/{location_id}/activeDirectories/{active_directory_id}.

sitestring

The Active Directory site the service will limit Domain Controller discovery too.

securityOperatorsstring[]

Optional. Domain users to be given the SeSecurityPrivilege.

netBiosPrefixstring

Required. NetBIOSPrefix is used as a prefix for SMB server name.

descriptionstring

Description of the active directory.

ldapSigningboolean

Specifies whether or not the LDAP traffic needs to be signed.

labelsobject

Labels for the active directory.

usernamestring

Required. Username of the Active Directory domain administrator.

administratorsstring[]

Optional. Users to be added to the Built-in Admininstrators group.

Response

Successful response