LDAP Sync

Post
/api/v1/ldap.syncNow
Premium tag

Syncs your LDAP data based on the data sync configurations. This endpoints requires 2FA.

Make sure LDAP is enabled in Settings > LDAP > Enable before using this endpoint.

Permission required: sync-auth-services-users.

Changelog

Version Description
5.2.0 Include syncAvatars
4.0.0 Added
Header parameters
X-Auth-Token
stringRequired

The authenticated user token.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The authenticated user ID.

ExamplerbAXPnMktTFbNpwtJ
x-2fa-code
stringRequired

The 2fa code. See Introduction to Two-Factor Authentication.

Example148750
x-2fa-method
stringRequired

The desired method to get the 2FA code. It can be email, totp, or password.

Responses
200

OK

Success Example
{
  "message": "Sync_in_progress",
  "success": true
}
object
message
string
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "TOTP Required [totp-required]",
  "errorType": "totp-required",
  "details": {
    "method": "totp",
    "codeGenerated": false,
    "availableMethods": [
      "totp"
    ]
  }
}
Example 2
{
  "success": false,
  "error": "LDAP_disabled"
}
Example 3
{
  "success": false,
  "error": "error-not-authorized"
}
Expand All
object
success
boolean
error
string
errorType
string
details
object
method
string
codeGenerated
boolean
availableMethods
Array of string
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string
Tags