Logo
MicroStrategy REST API API Documentation

Update an existing LDAP configuration

PATCH {{baseUrl}}/api/iserver/ldap/configuration

Update the existing LDAP configuration and save it to the Intelligence Server. There is only one LDAP configuration in Intelligence Server metadata, so this operation will replace the old configuration. The request body should only contain fields that will be updated.

 

Body PARAM

Key Datatype Required Description 
fields
null Comma-separated, top-level field whitelist that allows the client to selectively retrieve part of the response model. If specified, extra filtering is applied, and for top-level object (if root model is an array, each array element), only the listed fields are kept in the response. For example, "id,elements" keeps only the "id" field and whole "elements" array field, omitting all other fields in the top-level response model.



HEADERS

Key Datatype Required Description 
X-MSTR-AuthToken
string (Required) Authorization token
Content-Type
string




RESPONSES

status OK

The response is too large. Please view the response at https://github.com/MicroStrategy/rest-api-playground/blob/main/sample-responses/System-Administration/update-an-existing-LDAP-configuration/200-OK.json.



Curl
curl -X PATCH 'baseUrl/api/iserver/ldap/configuration?fields=' -H 'X-MSTR-AuthToken: authToken' -H 'Content-Type: application/json' -d '{"settings":{"serverHost":{"typeDescription":"String: NonNull"}}}'

ENDPOINTS