Directory object
A JSON representation of a directory object.
Common attributes
Examples
- User
-
{ "accountStatus": { "isDisabled": false, "isLocked": false, "expirationDate": null }, "passwordStatus": { "whenChanged": "2020-07-14T16:27:49.5590448Z", "expirationStatus": 0, "expirationDate": "2020-08-09T16:27:49.5590448Z" }, "guid": "7a4267ce-d354-44e7-8bd6-c681f1284a41", "dn": "CN=John Smith,CN=Users,DC=example,DC=com", "displayName": "John Smith", "objectType": "user", "objectTypeCode": 2, "domainName": "example.com", "directoryType": 1, "properties": { "department": [ "Marketing" ], "title": [ "Marketing analyst" ] } } - Group
-
{ "groupType": 1, "groupScope": 2, "membershipType": 0, "guid": "a7b63270-b8a4-4c34-b830-7e0d09f2e021", "dn": "CN=My Group,OU=Groups,DC=example,DC=com", "displayName": "My Group", "objectType": "group", "objectTypeCode": 3, "domainName": "example.com", "directoryType": 1, "properties": { "managedby": [ "CN=John Smith,CN=Users,DC=example,DC=com" ], "member": [ "CN=John Smith,CN=Users,DC=example,DC=com", "CN=Richard Magnus,CN=Users,DC=example,DC=com", "CN=Ella Parkes,CN=Users,DC=example,DC=com" ] } } - Computer
-
{ "computerType": 0, "accountStatus": { "isDisabled": false, "isLocked": false, "expirationDate": "2020-07-24T11:48:00Z" }, "passwordStatus": { "whenChanged": "2020-06-24T14:03:38.4738349Z", "expirationStatus": 1, "expirationDate": null }, "guid": "c69f8c85-e513-4dee-8135-16f0a29d2888", "dn": "CN=MYCOMPUTER,CN=Computers,DC=example,DC=com", "displayName": "MYCOMPUTER", "objectType": "computer", "objectTypeCode": 4, "domainName": "example.com", "directoryType": 1, "properties": { "managedby": [ "CN=John Smith,CN=Users,DC=example,DC=com" ] } } - OU
-
{ "guid": "0b4d238a-62fc-4088-0ff3-4ae2b108eed4", "dn": "OU=My Organizational Unit,DC=example,DC=com", "displayName": "My Organizational Unit", "objectType": "organizationalUnit", "objectTypeCode": 0, "domainName": "example.com", "directoryType": 1, "properties": {} } - Domain-DNS
-
{ "forestName": "example.com", "mode": 7, "forestMode": 6, "netbiosName": "EXAMPLE", "status": 2, "guid": "13b949ea-519f-4c29-abfc-95c50d40ae22", "dn": "DC=example,DC=com", "displayName": "example.com", "objectType": "domainDNS", "objectTypeCode": 5, "domainName": "example.com", "directoryType": 1, "properties": {} }
guid string
The GUID of the object.
dn string
The distinguished name of the object.
displayName string
The display name of the object. For information on how to change which property Adaxes takes object display names from, see Specify property for object display names.
objectType string
The type of the object. Takes the value from the Object Class property in the directory.
objectTypeCode enum
A numerical representation of the object type. Objects with the same objectTypeCode have the same set of type-specific attributes.
Show possible enum values
General = 0,
Contact = 1,
User = 2,
Group = 3,
Computer = 4,
DomainDns = 5,
ResourceMailbox = 6,
LinkedMailbox = 7,
PublicFolderMailbox = 8,
SystemMailbox = 9,
BusinessUnit = 100
domainName string
The name of the domain where the object is located.
domainName enum
The type of the directory where the object is located.
Show possible enum values
None = 0, // Unknown
OnPremise = 1, // Active Directory
AzureAD = 2 // Microsoft Entra ID
properties hash
A set of key-value pairs. Each pair represents a property name and its value(s). Each property is represented as an array, even if it's single-valued. This attribute will include only the properties you request when searching for objects or getting an object directly.
Type-specific attributes
Objects of a certain type have extra type-specific attributes in addition to the common ones.
User
accountStatus DirectoryAccountStatus
Information about the account status of the user.
Show attributes
accountStatus.isDisabled bool
Equals true if the account is disabled and false if not.
accountStatus.isLocked bool
Equals true if the account is locked and false if not.
accountStatus.expirationDate timestamp
Date when account expires.
passwordStatus DirectoryPasswordStatus
Information about the password status of the user.
Show attributes
passwordStatus.whenChanged timestamp
Date when the password was last changed or reset.
passwordStatus.expirationDate timestamp
Date when password will expire, if it can expire. Otherwise, the value is empty.
passwordStatus.expirationStatus enum
The password expiration status.
Show possible enum values
Expires = 0, // The password has expiration date. The password is either expired or will expire in some time
NeverExpires = 1, // The password never expires
NoExpiryMustBeChanged = 2, // No expiry (password must be changed)
NoExpirySmartCardRequired = 3, // No expiry (smart card is required)
NoExpiryInterdomainTrustAccount = 4 // No expiry (interdomain trust account card is required)
Resource, linked, system, or public folder mailbox
accountStatus DirectoryAccountStatus
Information about the account status of the mailbox.
Show attributes
accountStatus.isDisabled bool
Equals true if the account is disabled and false if not.
accountStatus.isLocked bool
Equals true if the account is locked and false if not.
accountStatus.expirationDate timestamp
Date when account expires.
Computer
accountStatus DirectoryAccountStatus
Information about the account status of the computer.
Show attributes
accountStatus.isDisabled bool
Equals true if the account is disabled and false if not.
accountStatus.isLocked bool
Equals true if the account is locked and false if not.
accountStatus.expirationDate timestamp
Date when account expires.
passwordStatus DirectoryPasswordStatus
Information about the password status of the computer.
Show attributes
passwordStatus.whenChanged timestamp
Date when the password was last changed or reset.
passwordStatus.expirationDate timestamp
Date when password will expire, if it can expire. Otherwise, the value is empty.
passwordStatus.expirationStatus enum
The password expiration status.
Show possible enum values
Expires = 0, // The password has expiration date. The password is either expired or will expire in some time
NeverExpires = 1, // The password never expires
NoExpiryMustBeChanged = 2, // No expiry (password must be changed)
NoExpirySmartCardRequired = 3, // No expiry (smart card is required)
NoExpiryInterdomainTrustAccount = 4 // No expiry (interdomain trust account card is required)
computerType enum
The computer type.
Show possible enum values
Workstation or Server = 0,
Domain Controller = 1
Group
groupType enum
The group type.
Show possible enum values
Distribution = 0,
Security = 1
groupScope enum
The group scope.
Show possible enum values
Local = 0,
Global = 1,
Universal = 2
membershipType enum
The group membership type.
Show possible enum values
Assigned = 0,
Rule-based = 1
Domain-DNS
forestName string
The forest name.
mode enum
The domain functional level.
Show possible enum values
Level2000Mixed = 0, // Windows 2000 mixed
Level2000Native = 1, // Windows 2000 native
Level2003Interim = 2, // Windows 2003 interim
Level2003 = 3, // Windows 2003
Level2008 = 4, // Windows 2008
Level2008R2 = 5, // Windows Server 2008 R2
Level2012 = 6, // Windows Server 2012
Level2012R2 = 7, // Windows Server 2012 R2
Level2016 = 8 // Windows Server 2016
forestMode enum
The forest functional level.
Show possible enum values
Level2000 = 0, // Windows 2000
Level2003Interim = 1, // Windows Server 2003 interim
Level2003 = 2, // Windows Server 2003
Level2008 = 3, // Windows Server 2008
Level2008R2 = 4, // Windows Server 2008 R2
Level2012 = 5, // Windows Server 2012
Level2012R2 = 6, // Windows Server 2012 R2
Level2016 = 7 // Windows Server 2016
netbiosName string
The NetBIOS name of the domain.
status enum
The operational status of a managed domain.
Show possible enum values
Inactive = 0, // The domain is not operational because it is being initialized or an internal error has occurred
Unregistered = 1, // The domain is not operational because credentials were not provided
Operating = 2 // The domain is fully operational and available to access via Adaxes service
Business unit
rootContainerDN string
The distinguished name of the container where the business unit is located.