| _create_time |
Timestamp of resource creation |
EpochMsTimestamp |
Readonly
Sortable |
| _create_user |
ID of the user who created this resource |
string |
Readonly |
| _last_modified_time |
Timestamp of last modification |
EpochMsTimestamp |
Readonly
Sortable |
| _last_modified_user |
ID of the user who last modified this resource |
string |
Readonly |
| _links |
References related to this resource
The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink |
Readonly |
| _protection |
Indicates protection status of this resource
Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
|
string |
Readonly |
| _revision |
Generation of this resource config
The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. |
int |
|
| _schema |
Schema for this resource |
string |
Readonly |
| _self |
Link to this resource |
SelfResourceLink |
Readonly |
| _system_owned |
Indicates system owned resource |
boolean |
Readonly |
| base_distinguished_name |
Directory domain base distinguished name
Each active directory domain has a domain naming context (NC), which contains domain-specific data. The root of this naming context is represented by a domain's distinguished name (DN) and is typically referred to as the NC head. |
string |
Required |
| description |
Description of this resource |
string |
Maximum length: 1024
Sortable |
| display_name |
Identifier to use when displaying entity in logs or GUI
Defaults to ID if not set |
string |
Maximum length: 255
Sortable |
| event_log_servers |
Event Log server of directory domain
Directory domain Event Log server's information including host, name, protocol and so on. |
array of DirectoryEventLogServer |
Readonly
Maximum items: 50 |
| id |
Unique identifier of this resource |
string |
Sortable |
| ldap_servers |
LDAP server of directory domain
Directory domain LDAP servers' information including host, name, port, protocol and so on. |
array of DirectoryLdapServer |
Required
Maximum items: 50 |
| name |
Directory domain name
Directory domain name which best describes the domain. It could be unique fqdn name or it could also be descriptive. There is no unique contraint for domain name among different domains. |
string |
Required |
| netbios_name |
Directory domain NETBIOS name
NetBIOS names can contain all alphanumeric characters except for the certain disallowed characters. Names can contain a period, but names cannot start with a period. NetBIOS is similar to DNS in that it can serve as a directory service, but more limited as it has no provisions for a name hierarchy and names are limited to 15 characters. The netbios name is case insensitive and is stored in upper case regardless of input case. |
string |
Required |
| resource_type |
Must be set to the value DirectoryAdDomain |
string |
Required
Enum: DirectoryAdDomain |
| selective_sync_settings |
SelectiveSync settings
SelectiveSync settings toggle the SelectiveSync feature and
selected OrgUnits. If this is not specified, SelectiveSync is
disabled by default.
|
SelectiveSyncSettings |
|
| sync_settings |
Directory domain sync settings
Each domain sync settings can be changed using this object. It is not required since there are default values used if there is no specification for this object. |
DirectoryDomainSyncSettings |
|
| tags |
Opaque identifiers meaningful to the API user |
array of Tag |
Maximum items: 30 |