Cisco Acano X-series 開発者ガイド

11.3.3 Retrieving detailed information on a LDAP Source

GET method performed on a “/ldapSources/<ldapSource ID>” node. If the ldapSource ID
supplied is valid, a “200 OK” response is received, with XML content as per LDAP source
creation described above.

11.4 LDAP Sync Methods

API support for LDAP synchronization comprises the ability to:

n

Trigger a new sync via the API

n

Monitor pending and in-progress LDAP syncs

There is a top-level /ldapSyncs node in the object tree, and associated GET, DELETE, POST
methods to use on objects underneath it.

11.4.1 Retrieving scheduled LDAP sync methods

GET method on the "/ldapSyncs" node.

Parameters

Type/Value

Description/Notes

offset
limit

Number
Number

An "offset" and "limit" can be supplied to retrieve elements other than the first
"page" in the notional list (see

).

Response elements

Type/Value

Description/Notes

Returns results in the form "<ldapSyncs total=N> ...

</ldapSyncs>", with N being the total number of pending
and in-progress LDAP sync methods.

Within the encompassing "<ldapSyncs>" are one or more
"<ldapSync id=ID>" nodes; each of the form on the left,
where: state is either "inProgress" (happening now) ,
"pending" (yet to be started), completed or failed

ldapSyncid

ID

state

inProgress|
pending|
complete|
failed

The current status of this LDAP sync operation:
inProgress - this LDAP sync operation is happening now
pending - this LDAP sync operation has yet to start
complete - this LDAP sync operation has completed
successfully
failed - this LDAP sync operation has failed

failureReason

tenantDoesNotExist|

ldapSourceDoes

NotExist|
clashOccurred|
ldapError