PUT/v1/user/ldap

Create an LDAP user

Creates an LDAP-backed user that references an existing LDAP object. Supply the required username and the LDAP dn; the authenticated user needs ACCESS_MANAGEMENT or ACCESS_MANAGEMENT_CREATE permission.

5 body fields

LDAP user details, including the username and LDAP directory reference.

dnstringoptional
The LDAP distinguished name. Must contain 1–255 characters and no control characters.
emailstringoptional
The user's email address. Maximum 255 characters; control characters are not allowed.
permissionsarray<object>optional
Permissions assigned to the LDAP user.
teamsarray<object>optional
Teams to associate with the LDAP user.
usernamestringrequired
The user's username. Must contain 1–255 characters and no control characters.

4 status codes
201Returns the created LDAP user, including its username and any supplied LDAP details, permissions, and teams.
dnstringoptional
emailstringoptional
permissionsarray<object>optional
teamsarray<object>optional
usernamestringrequired
400Returned when the username is null or blank.
401Returned when the request is unauthorized.
409Returned when a user with the same username already exists.

Error handling

username is required, must contain 1–255 characters, and must not contain control characters; a missing or blank username returns a 400. A 401 indicates an unauthorized request, and a 409 means a user with the same username already exists. The authenticated user needs ACCESS_MANAGEMENT or ACCESS_MANAGEMENT_CREATE permission.