Skip to main content

DirectorySync

A DirectorySync defines the information returned about the directory sync configuration of a directory.

Properties

NameTypeDescriptionNotes
crawlFrequencyIntegerThe rate at which the directory will be queried in milliseconds[optional]
directoryDirectory[optional]
directoryIdStringThe ID of the directory.[optional]
directorySyncAgentIdStringThe UUID of the Directory Sync Gateway Agent.[optional]
groupNameAttributeStringThe group name attribute[optional]
groupObjectClassStringThe Group Object Class[optional]
groupSynchronizationTypeGroupSynchronizationTypeEnumGroup synchronization will be done based on the selected option.[optional]
idStringThe UUID of the directory.[optional]
lastUpdateOffsetDateTimeThe last time the directory was updated.[optional]
pageSizeIntegerThe number of records that should returned per query. Default is 25.[optional]
stateStateEnumThe status of the Directory Sync.[optional]
userDesyncPolicyUserDesyncPolicyEnumUser synchronization will be done based on the selected option.[optional]
userObjectClassStringThe User Object Class[optional]
userUniqueIdAttributeStringThe User Unique Id Attribute[optional]
waitBetweenNotificationsIntegerHow long to wait between notifications in milliseconds.[optional]

GroupSynchronizationTypeEnum

NameValue
ALL"ALL"
FILTER"FILTER"
NONE"NONE"

StateEnum

NameValue
UNKNOWN"UNKNOWN"
ERROR"ERROR"
PENDING_CHANGES"PENDING_CHANGES"
SYNCED"SYNCED"
OUT_OF_SYNC"OUT_OF_SYNC"
CRAWLING"CRAWLING"
CRAWL_COMPLETE"CRAWL_COMPLETE"
NOTIFYING_GROUPS"NOTIFYING_GROUPS"
NOTIFYING_GROUPS_USERS"NOTIFYING_GROUPS_USERS"
NOTIFYING_USERS"NOTIFYING_USERS"
NOTIFY_COMPLETE"NOTIFY_COMPLETE"
SYNCING"SYNCING"
FAILED"FAILED"

UserDesyncPolicyEnum

NameValue
LOCALLY_MANAGED_ENABLED"USER_LOCALLY_MANAGED_ENABLED"
LOCALLY_MANAGED_DISABLED"USER_LOCALLY_MANAGED_DISABLED"
DELETED"USER_DELETED"