List directory sync settings
GET/api/web/v1/directories/:id/directorysyncs
List all directory sync settings associated with the given directory sync agent. Caller requires the DIRECTORIES:VIEW permission.
Request
Path Parameters
The UUID of the directory sync agent whose directory sync settings are to be returned.
Responses
- 200
- 400
- 401
- 403
- 404
- 409
Successful
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
]
Array [
]
Array [
]
]
The rate at which the directory will be queried in milliseconds
directory
object
A Directory defines the information returned about a directory.
The name of the AD attribute value that will be mapped into comma seperated string value of alias
directoryAttributeMappings
object[]
Directory attribure mappings.
The name of the directory attribute being mapped.
The UUID of the Directory the attribute mapping belongs to.
The UUID of the attribute mapping.
userAttribute
object
Information about user attribute definitions.
The UUID for this user attribute. Generated when the user attribute is created.
A flag indicating if users must have a value for this user attribute.
The name of this user attribute.
A flag indicating if this user attribute is one of the system defined user attributes.
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.
A flag indicating if this attribute is intended to be unique.
The UUID of the Identity as a Service User Attribute being mapped to.
directoryConnections
object[]
The connections that you want to connect when syncing.
The UUID of the Directory the connection belongs to.
The Directory hostname or IP address.
The UUID of the Directory connection.
The Directory port.
Whether or not to connect to the Directory using an SSL certificate.
The UUID of the directory sync
groupFilters
object[]
Directory group filters.
The UUID of the Directory the group filter belongs to.
The UUID of the group filter.
The name of the group to filter on.
The hostname of the Directory Can be an IP address or a hostname.
The UUID of the Directory.
The name of the Directory.
The password to connect to the Directory with.
The port to connect to the Directory over.
The root domain naming context of the Directory.
searchBases
object[]
The searchbases that you want to search when syncing.
The UUID of the Directory the seachbase belongs to.
Whether or not an empty searchbase is empty?
The UUID of the searchbase.
The searchbase node.
Whether or not a sub-tree is included?
Possible values: [AD
, LDAP
]
The type of the Directory.
Whether or not to connect to the Directory using an SSL certificate.
The username to connect to the Directory with. Value must be a fully distinguished name or UPN.
The ID of the directory.
The UUID of the Directory Sync Gateway Agent.
The group name attribute
The Group Object Class
Possible values: [ALL
, FILTER
, NONE
]
Group synchronization will be done based on the selected option.
The UUID of the directory.
The last time the directory was updated.
The number of records that should returned per query. Default is 25.
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.
Possible values: [USER_LOCALLY_MANAGED_ENABLED
, USER_LOCALLY_MANAGED_DISABLED
, USER_DELETED
]
User synchronization will be done based on the selected option.
The User Object Class
The User Unique Id Attribute
How long to wait between notifications in milliseconds.
[
{
"crawlFrequency": 3600000,
"directory": {
"aliasMappingName": "adminDescription,adminDisplayName",
"directoryAttributeMappings": [
{
"directoryAttributeName": "givenName",
"directoryId": "6781549d-433c-44ea-a42f-4705c26f3245",
"id": "6781549d-433c-44ea-a42f-4705c26f3245",
"userAttribute": {
"id": "string",
"mandatory": true,
"name": "string",
"systemDefined": true,
"type": "OTP_EMAIL",
"unique": true
},
"userAttributeId": "6781549d-433c-44ea-a42f-4705c26f3245"
}
],
"directoryConnections": [
{
"certificate": "string",
"directoryId": "6781549d-433c-44ea-a42f-4705c26f3245",
"hostname": "10.4.1.2 or directory.server.com",
"id": "string",
"port": 389,
"useSsl": true
}
],
"directorySyncId": "6781549d-433c-44ea-a42f-4705c26f3245",
"groupFilters": [
{
"directoryId": "6781549d-433c-44ea-a42f-4705c26f3245",
"id": "6781549d-433c-44ea-a42f-4705c26f3245",
"name": "Engineering"
}
],
"id": "6781549d-433c-44ea-a42f-4705c26f3245",
"name": "Directory",
"password": "string",
"rootDomainNamingContext": "DC=AnyCorp,DC=biz",
"searchBases": [
{
"directoryId": "6781549d-433c-44ea-a42f-4705c26f3245",
"emptySearchBase": true,
"id": "6781549d-433c-44ea-a42f-4705c26f3245",
"node": "DC=Users",
"subsearchbasesIncluded": true
}
],
"type": "AD",
"userName": "CN=Administrator,CN=Users,DC=AnyCorp,DC=biz or Administrator@AnyCorp.biz"
},
"directoryId": "string",
"directorySyncAgentId": "6781549d-433c-44ea-a42f-4705c26f3245",
"groupNameAttribute": "string",
"groupObjectClass": "groupOfNames",
"groupSynchronizationType": "ALL, FILTER or NONE",
"id": "6781549d-433c-44ea-a42f-4705c26f3245",
"lastUpdate": "2019-02-19T13:15:27Z",
"pageSize": 25,
"state": "CRAWLING",
"userDesyncPolicy": "USER_DELETED",
"userObjectClass": "string",
"userUniqueIdAttribute": "string",
"waitBetweenNotifications": 500
}
]
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Access denied
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Conflict
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}