Update LDAP configuration

Updates the LDAP authentication configuration.

Requires one of the following license types: ioa, ioaPreview, or ioe. See License Types.

Requires the Edit permission on the LDAP authentication entity (edit:ldap-configuration). See Identity Exposure Permissions.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
boolean

Specifies whether LDAP authentication is enabled.

string | null

Specifies the URL of the LDAP server, beginning with ldap:// or ldaps:// and ending with the domain name and port.

string | null

Specifies the service account that searches the LDAP server for users, as a distinguished name (DN), SAM account name or user principal name.

string | null

Specifies the password of the service account.

string | null

Specifies the LDAP directory to search for users, beginning with DC= or OU=.

string | null

Specifies the LDAP filter that matches users who sign in.

allowedGroups
array of objects | null

Specifies the groups whose members can sign in, each with the default security profile and roles for users created at their first sign-in.

allowedGroups
boolean

Specifies whether to use SASL binding with the LDAP server.

number | null

Specifies the ID of the relay that connects to the LDAP server.

Responses

401

Returned if the API key specified in your request is invalid.

500

Returned if an internal error occurred.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json