Terminating User Login Session using REST API in Bold BI

This article provides guidance on how to terminate a user login session in Bold BI using the REST API. The API requires client credentials (client ID and secret) for authentication.

Ending the active user session

To end the user’s session, you can use the following API endpoint. In the request URL, please pass the user id, username or email address of the user.

Query Parameter

You have the option to terminate all active sessions of the user or specific sessions of the user. To terminate a specific session, you need to pass the session ID in the query parameter.

To obtain the active session, please refer to the Get user’s active session API.

Authentication

To learn how to obtain the authentication token, please visit this link. You need to include the access token in the request header as follows:

Sample Request

Sample Response

{
   "api_status": true,
   "data": null,
   "status": true,
   "status_message": "The user session has ended successfully."
} 

Response Codes