DirectoryConfiguration
Description
An object representation of Active Directory server connection properties. The directory server is used to download users and groups. (Note: The field level constraints listed here might not cover all the constraints on the field. Additional constraints might exist.)
Model Properties
| Property | Required | Type | Description | ||
|---|---|---|---|---|---|
| hostname | True | string | A mandatory Unicode string representing the hostname or IP address of the directory server. If an encryption connection is used, a fully-qualified domain name is required, not the IP address. Field level constraints: cannot be null, must be a valid host (FQDN or IP) or a list of valid hosts. (Note: Additional constraints might exist) |
||
| port | True | integer | The port number used for communications with the server. The default is 389. Use port 636 if you select LDAPS as the encryption method. Field level constraints: cannot be null. (Note: Additional constraints might exist) |
||
| encryptionProtocol | False | string | An enum value that specifies the encryption protocol used to connect and download users and group information. Values can be one of the following. NONE - Do not use encryption, users and group information will be downloaded in clear text. STARTTLS - Use the strongest encryption method supported by the directory server. This option is not supported when using realm for remote access VPN. LDAPS - Use LDAP over SSL. |
||
| encryptionCert | False | object | If encrypted method is selected, a Certificate Authority (CA) certificate is required to enable a trusted connection between the system and the directory server. Allowed types are: [ExternalCACertificate] |
||
| type | True | string | A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name. | ||