Logo
MicroStrategy REST API API Documentation

Get LDAP batch import status

GET {{baseUrl}}/api/iserver/ldap/import

Get LDAP batch import status. You can get the progress of LDAP batch import, including its status (e.g. failed, stopped, undergoing, and canceled). If there is LDAP batch import undergoing, you can also get the number of users and groups which have already been imported.

 

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




RESPONSES

status OK

{ "statusDescription": "No import", "totalUsers": 0, "totalImportedUsers": 0, "totalFailedImportedUsers": 0, "totalGroups": 0, "totalImportedGroups": 0, "totalFailedImportedGroups": 0, "startTime": "", "finishTime": "" }



Curl
curl -X GET 'baseUrl/api/iserver/ldap/import?fields=' -H 'X-MSTR-AuthToken: authToken'

ENDPOINTS