How to revoke site access from the user using Bold BI REST API?

Published:

To remove access from user in the user management server (UMS) using REST API, you need to first authenticate yourself using the API access token. Once you have successfully authenticated, you must obtain your tenant ID and user ID before using the API to remove access from the user.

Authentication

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.

Header Name	Header Value
Authorization	Bearer *<access_token>*

URI Parameters

Parameter Name	Type	Required	Comments
tenant_id	Guid	YES	Id of the tenant

Steps to remove site access to the User

Pass the access token generated from the token endpoint in the Authorization header.
Authorization header included with the POST request
You can remove site access to the user by using the below API endpoint.
METHOD
POST
URL
/api/v2.0/tenant/{tenant_id}/remove-access
Note: Please refer to this document to get the tenant ID.
Post request to remove site access to the user in user management server.
Include anyone of the following details in the body of the request in JSON format.
Parameter Name
Type
Required
Comments
user_id
Guid
No
Unique id of the user.
Refer to this document to get the user ID.
email
String
No
Email address of the user
username
String
No
Username of the user

Sample POST Request
JSON data included with the POST request to add new user
If the user access to site is removed successfully, you will receive response message code 204.
Code
Description
Comment
204
No Content
Returns 204, If the user access to site is removed successfully