REST Resource: projects.locations.activeDirectories

Resource: ActiveDirectory
- JSON representation
State
Methods

Resource: ActiveDirectory

ActiveDirectory is the public representation of the active directory config.

JSON representation

JSON representation
{ "name" : string , "createTime" : string , "state" : enum ( `State` ) , "domain" : string , "site" : string , "dns" : string , "netBiosPrefix" : string , "organizationalUnit" : string , "aesEncryption" : boolean , "username" : string , "password" : string , "backupOperators" : [ string ] , "administrators" : [ string ] , "securityOperators" : [ string ] , "kdcHostname" : string , "kdcIp" : string , "nfsUsersWithLdap" : boolean , "description" : string , "ldapSigning" : boolean , "encryptDcConnections" : boolean , "labels" : { string : string , ... } , "stateDetails" : string }

 { 
 "name" 
 : 
 string 
 , 
 "createTime" 
 : 
 string 
 , 
 "state" 
 : 
 enum (  State 
 
) 
 , 
 "domain" 
 : 
 string 
 , 
 "site" 
 : 
 string 
 , 
 "dns" 
 : 
 string 
 , 
 "netBiosPrefix" 
 : 
 string 
 , 
 "organizationalUnit" 
 : 
 string 
 , 
 "aesEncryption" 
 : 
 boolean 
 , 
 "username" 
 : 
 string 
 , 
 "password" 
 : 
 string 
 , 
 "backupOperators" 
 : 
 [ 
 string 
 ] 
 , 
 "administrators" 
 : 
 [ 
 string 
 ] 
 , 
 "securityOperators" 
 : 
 [ 
 string 
 ] 
 , 
 "kdcHostname" 
 : 
 string 
 , 
 "kdcIp" 
 : 
 string 
 , 
 "nfsUsersWithLdap" 
 : 
 boolean 
 , 
 "description" 
 : 
 string 
 , 
 "ldapSigning" 
 : 
 boolean 
 , 
 "encryptDcConnections" 
 : 
 boolean 
 , 
 "labels" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "stateDetails" 
 : 
 string 
 }

Fields
`name`	`string` Identifier. The resource name of the active directory. Format: `projects/{projectNumber}/locations/{locationId}/activeDirectories/{activeDirectoryId}` .
`createTime`	`string ( Timestamp format)` Output only. Create time of the active directory. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"` , `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"` .
`state`	`enum ( State )` Output only. The state of the AD.
`domain`	`string` Required. Name of the Active Directory domain
`site`	`string` The Active Directory site the service will limit Domain Controller discovery too.
`dns`	`string` Required. Comma separated list of DNS server IP addresses for the Active Directory domain.
`netBiosPrefix`	`string` Required. NetBIOSPrefix is used as a prefix for SMB server name.
`organizationalUnit`	`string` The Organizational Unit (OU) within the Windows Active Directory the user belongs to.
`aesEncryption`	`boolean` If enabled, AES encryption will be enabled for SMB communication.
`username`	`string` Required. Username of the Active Directory domain administrator.
`password`	`string` Required. Password of the Active Directory domain administrator.
`backupOperators[]`	`string` Optional. Users to be added to the Built-in Backup Operator active directory group.
`administrators[]`	`string` Optional. Users to be added to the Built-in Admininstrators group.
`securityOperators[]`	`string` Optional. Domain users to be given the SeSecurityPrivilege.
`kdcHostname`	`string` Name of the active directory machine. This optional parameter is used only while creating kerberos volume
`kdcIp`	`string` KDC server IP address for the active directory machine.
`nfsUsersWithLdap`	`boolean` If enabled, will allow access to local users and LDAP users. If access is needed for only LDAP users, it has to be disabled.
`description`	`string` Description of the active directory.
`ldapSigning`	`boolean` Specifies whether or not the LDAP traffic needs to be signed.
`encryptDcConnections`	`boolean` If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.
`labels`	`map (key: string, value: string)` Labels for the active directory. An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }` .
`stateDetails`	`string` Output only. The state details of the Active Directory.

State

The Active Directory States

Enums
`STATE_UNSPECIFIED`	Unspecified Active Directory State
`CREATING`	Active Directory State is Creating
`READY`	Active Directory State is Ready
`UPDATING`	Active Directory State is Updating
`IN_USE`	Active Directory State is In use
`DELETING`	Active Directory State is Deleting
`ERROR`	Active Directory State is Error
`DIAGNOSING`	Active Directory State is Diagnosing.

Methods
`create`	CreateActiveDirectory Creates the active directory specified in the request.
`delete`	Delete the active directory specified in the request.
`get`	Describes a specified active directory.
`list`	Lists active directories.
`patch`	Update the parameters of an active directories.

REST Resource: projects.locations.activeDirectories

Resource: ActiveDirectory

State

Methods

`create`

`delete`

`get`

`list`

`patch`

REST Resource: projects.locations.activeDirectories Stay organized with collections Save and categorize content based on your preferences.

Resource: ActiveDirectory

State

Methods

create

delete

get

list

patch

REST Resource: projects.locations.activeDirectories

`create`

`delete`

`get`

`list`

`patch`