API Guide

PUT /auth/servers/ldap
Configures LDAP server information.
API
PUT /auth/servers/ldap
Description This API configures LDAP server credentials to verify authentication with the URL.
Parameters
Table 18. API parameters
Filter name Description
body *
required (body)
Configure LDAP with the URL and credentials.
{
"url": "ldap://
ds.example.com:389",
"username": "admin",
"password": "adminPassword",
"attributes": "dc=example,dc=com"
}
Responses 201 — New entity created successfully
{
"new_object_id": "string",
"id": "string",
"message": "string",
"messageParams": [
"string"
],
"messages": [
{
"id": "string",
"message": "string",
"field_name": "string",
"messageParams": [
"string"
]
}
]
}
401 — You are not authorized to perform this operation
{
"new_object_id": "string",
"id": "string",
"message": "string",
"messageParams": [
"string"
],
"messages": [
{
"id": "string",
"message": "string",
"field_name": "string",
"messageParams": [
"string"
]
}
]
}
default — Success or error response
{
"new_object_id": "string",
38
Authentication