How to delete the user using Bold BI REST API?
All REST API endpoints are protected using OAuth 2.0. To access this API, you need to get an access token. Please refer to this document to get the access token.
Authorization Header
An Authorization header is an HTTP header that contains an authentication token or credentials sent by the client to the server. Pass the access token received from the token endpoint in the Authorization header.
Header Name
Header Value
Authorization
Bearer <access_token>
All REST API endpoints are protected using OAuth 2.0. To access this API, you need to get an access token. Please refer to this document to get the access token.
Authorization Header
| Header Name | Header Value |
| Authorization | Bearer <access_token> |
Get the user id by referring to this document.
Construct the DELETE request with user id and send the request.
METHOD DELETE URL https://{yourdomain}/api/v2.0/user/{userId}
Response Codes
|
Code |
Description |
Comment |
|
204 |
No Content |
Returns 204, If the user is deleted successfully |
URI Parameters
Parameter Name | Type | Required | Comments |
userId | Guid | Yes | User Id of the user in UMS. |
Error Messages
|
HTTP Status Code |
Description |
Error Code |
Error Message |
|
401 |
Unauthorized |
- |
- |
|
500 |
Internal Server Error |
- |
- |
Related links
How to Generate Access Token from User Management Server using Bold BI REST API
- How to Add a new User to the user management server using Bold BI REST API
How to Grant Site Access to the User in the user management server using the Bold BI REST API
How to Remove Site Access to the User in user management server using Bold BI REST API
