LDAP User Sources Resource

GET /admin/user_sources

Retrieves all of the configured LDAP User Sources.

Response Body
media type data type description
application/json SearchResultList (JSON) A SearchResultList of LdapUserSource objects.
application/xml searchResultList (XML)

POST /admin/user_sources

Creates a new LDAP User Source.

The following LDAP User Source fields are mandatory:

  • url
  • username_attribute
  • guid_attribute
  • username
  • password
  • user_contexts

Request Body
media type data type
application/json LdapUserSource (JSON)
application/xml ldapUserSource (XML)
Response Body
media type data type description
application/json LdapUserSource (JSON) The new Ldap User Source object.
application/xml ldapUserSource (XML)

POST /admin/user_sources/sync

Triggers a sync of all LDAP User Sources.

The request blocks until the sync has completed.

Response Body
media type data type description
application/json LdapSyncResults (JSON) The LDAP sync results.
application/xml ldapSyncResults (XML)

GET /admin/user_sources/sync_config

Retrieves the current User Source Synchronization settings.

Response Body
media type data type description
application/json UserSourceSynchronization (JSON) The UserSourceSynchronization object.
application/xml userSourceSynchronization (XML)

PUT /admin/user_sources/sync_config

Updates the User Source Synchronization settings. Only the fields that are included in the request body are updated.

Request Body
media type data type
application/json UserSourceSynchronization (JSON)
application/xml userSourceSynchronization (XML)
Response Body
media type data type description
application/json UserSourceSynchronization (JSON) The updated UserSourceSynchronization settings.
application/xml userSourceSynchronization (XML)

DELETE /admin/user_sources/{id}

Deletes an LDAP User Source.

Request Parameters
name type description
id path
Response Codes
code condition
204 The LDAP User Source is deleted successfully
404 (LDAP_CONFIG_NOT_FOUND) No LDAP User Source exists with the specified ID.

GET /admin/user_sources/{id}

Retrieves an LDAP User Source.

Request Parameters
name type description
id path
Response Codes
code condition
404 (LDAP_CONFIG_NOT_FOUND) No LDAP User Source exists with the specified ID.
Response Body
media type data type
application/json LdapUserSource (JSON)
application/xml ldapUserSource (XML)