Skip to main content

List directories

GET 
/api/web/v1/directories

List all directories. Caller requires the DIRECTORIES:VIEW permission.

The following attributes are not included in the returned Directory object: directoryAttributeMappings, directorySync, groupFilters, searchBases. The get directory API can be used to acquire these attribute for a specific directory.

Responses​

Successful

Schema

  • Array [

    • aliasMappingName string

    The name of the AD attribute value that will be mapped into comma seperated string value of alias

    certificate bytedeprecated

    directoryAttributeMappings

    object[]

    Directory attribure mappings.

  • Array [

    • directoryAttributeName string

    The name of the directory attribute being mapped.

    directoryId string

    The UUID of the Directory the attribute mapping belongs to.

    id string

    The UUID of the attribute mapping.

    userAttribute

    object

    Information about user attribute definitions.

    id string

    The UUID for this user attribute. Generated when the user attribute is created.

    mandatory booleanrequired

    A flag indicating if users must have a value for this user attribute.

    name stringrequired

    The name of this user attribute.

    systemDefined booleanrequired

    A flag indicating if this user attribute is one of the system defined user attributes.

    type string

    Possible values: [NONE, OTP_EMAIL, OTP_SMS, OTP_VOICE]

    Type of user attribute. Currently only used to specify the type of contact if the attribute is to be used for OTP delivery.

    unique booleanrequired

    A flag indicating if this attribute is intended to be unique.

    userAttributeId string

    The UUID of the Identity as a Service User Attribute being mapped to.

  • ]

    • directoryConnections

    object[]

    The connections that you want to connect when syncing.

  • Array [

    • certificate byte
    directoryId string

    The UUID of the Directory the connection belongs to.

    hostname string

    The Directory hostname or IP address.

    id string

    The UUID of the Directory connection.

    port int32

    The Directory port.

    useSsl boolean

    Whether or not to connect to the Directory using an SSL certificate.

  • ]

    • directorySync

    object

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

    crawlFrequency int32

    The rate at which the directory will be queried in milliseconds

    directory
    directoryId string

    The ID of the directory.

    directorySyncAgentId string

    The UUID of the Directory Sync Gateway Agent.

    groupNameAttribute string

    The group name attribute

    groupObjectClass string

    The Group Object Class

    groupSynchronizationType string

    Possible values: [ALL, FILTER, NONE]

    Group synchronization will be done based on the selected option.

    id string

    The UUID of the directory.

    lastUpdate date-time

    The last time the directory was updated.

    pageSize int32

    The number of records that should returned per query. Default is 25.

    state string

    Possible values: [UNKNOWN, ERROR, PENDING_CHANGES, SYNCED, OUT_OF_SYNC, CRAWLING, CRAWL_COMPLETE, NOTIFYING_GROUPS, NOTIFYING_GROUPS_USERS, NOTIFYING_USERS, NOTIFY_COMPLETE, SYNCING, FAILED]

    The status of the Directory Sync.

    userDesyncPolicy string

    Possible values: [USER_LOCALLY_MANAGED_ENABLED, USER_LOCALLY_MANAGED_DISABLED, USER_DELETED]

    User synchronization will be done based on the selected option.

    userObjectClass string

    The User Object Class

    userUniqueIdAttribute string

    The User Unique Id Attribute

    waitBetweenNotifications int32

    How long to wait between notifications in milliseconds.

    directorySyncId string

    The UUID of the directory sync

    groupFilters

    object[]

    Directory group filters.

  • Array [

    • directoryId string

    The UUID of the Directory the group filter belongs to.

    id string

    The UUID of the group filter.

    name string

    The name of the group to filter on.

  • ]

    • hostname stringdeprecated

    The hostname of the Directory Can be an IP address or a hostname.

    id string

    The UUID of the Directory.

    name string

    The name of the Directory.

    password string

    The password to connect to the Directory with.

    port int32deprecated

    The port to connect to the Directory over.

    rootDomainNamingContext string

    The root domain naming context of the Directory.

    searchBases

    object[]

    The searchbases that you want to search when syncing.

  • Array [

    • directoryId string

    The UUID of the Directory the seachbase belongs to.

    emptySearchBase boolean

    Whether or not an empty searchbase is empty?

    id string

    The UUID of the searchbase.

    node string

    The searchbase node.

    subsearchbasesIncluded boolean

    Whether or not a sub-tree is included?

  • ]

    • type string

    Possible values: [AD, LDAP]

    The type of the Directory.

    useSsl booleandeprecated

    Whether or not to connect to the Directory using an SSL certificate.

    userName string

    The username to connect to the Directory with. Value must be a fully distinguished name or UPN.

  • ]

Loading...