Managing Users via Bold Reports REST API (v5.0)
This article explains how to manage users in Bold Reports using the REST API v5.0. It covers common user administration tasks such as creating users, adding users to default groups, updating user information, activating or deactivating accounts, deleting users, and retrieving user and group details. Each section includes the endpoint, HTTP method, request payload, sample response, and Postman example.
Prerequisites
Before invoking the APIs listed in this article:
- Generate a valid access token.
- Include the token in the Authorization header.
- Ensure the account has administrative privileges for user management operations.
Example:
Authorization: Bearer {access_token}
Content-Type: application/json
Contents
- Add Users to a Default Group
- Edit User
- Delete User
- Activate or Deactivate User
- Get List of Users
- Get User Details
- Get User Groups
Add User(s) to Default Group
Add a user to the configured default group by setting IsAddtoDefaultGroup to true in the request body.
We must set the default group in the account settings before adding users to the default group.
Method: POST
Request URI: https://{yourdomain}/reporting/api/site/{tenant-name}/v5.0/users
Example URI: http://localhost:59774/reporting/api/site/site1/v5.0/users
Request Body:
{
"Email": "string",
"FirstName": "string",
"Lastname": "string",
"Password": "string",
"IsAddtoDefaultGroup": true
}
Example Request Body:
{
"Email": "[email protected]",
"FirstName": "John",
"Lastname": "A",
"Password": "Admin@123",
"IsAddtoDefaultGroup": true
}
Response:
{
"ApiStatus": true,
"Data": "9",
"Status": true,
"StatusMessage": "User has been successfully added to the default group, ReportServer selected in the account settings."
}
Postman Snapshot:
Edit User
This endpoint allows administrators to update an existing user’s details by providing the modified values in the request body.
Method: PUT
Request URI: https://{yourdomain}/reporting/api/site/{tenant-name}/v5.0/users/{user}
Example URI: http://localhost:59774/reporting/api/site/site1/v5.0/users/[email protected]
Request Body:
{
"ContactNumber": "string",
"Email": "string",
"UserName": "string",
"FirstName": "string",
"Lastname": "string"
}
Example Request Body:
{
"ContactNumber": "2893784752",
"Email": "[email protected]",
"UserName": "johnupdated",
"FirstName": "Johnnew",
"Lastname": "Abi"
}
Response:
{
"ApiStatus": true,
"Status": true,
"StatusMessage": "User profile has been updated successfully."
}
Postman Snapshot:
Delete User
With this endpoint administrator can delete the specific user on the server by providing user email address in the user parameter.
Method: DELETE
Request URI: https://{yourdomain}/reporting/api/site/{tenant-name}/v5.0/users/{user}
Example URI: http://localhost:59774/reporting/api/site/site1/v5.0/users/[email protected]
Response:
{
"ApiStatus": true,
"Status": true,
"StatusMessage": "User has been deleted successfully"
}
Postman Snapshot:
Activate Or Deactivate User
With this endpoint, administrators can activate or deactivate the user account in the server by providing the email address in the path parameter and activation or de-activation request in the request body.
Method: POST
Request URI: https://{yourdomain}/reporting/api/site/{tenant-name}/v5.0/users/{user}
Example URI: http://localhost:59774/reporting/api/site/site1/v5.0/users/[email protected]
Request Body to activate the user:
{
"Activate": true
}
Request Body to deactivate the user:
{
"Activate": false
}
Response when activating the user:
{
"ApiStatus": true,
"Status": true,
"StatusMessage": "User has been activated successfully."
}
Response when deactivating the user:
{
"ApiStatus": true,
"Status": true,
"StatusMessage": "user has been de-activated successfully."
}
Postman Snapshots:
Activate User:
Deactivate User:
Get List Of Users
With this endpoint, the user can get the list of user information from the server.
Method: GET
Request URI: https://{yourdomain}/reporting/api/site/{tenant-name}/v5.0/users
Example URI: http://localhost:59774/reporting/api/site/site1/v5.0/users
Response:
{
"UserList": [
{
"ContactNumber": "",
"DisplayName": "John A",
"Email": "[email protected]",
"FirstName": "John",
"IsActive": true,
"IsActiveDirectoryUser": false,
"IsAzureAdUser": false,
"Lastname": "A",
"UserId": 3,
"Username": "[email protected]",
"UserStatus": 0
},
{
"ContactNumber": "",
"DisplayName": "John Doe",
"Email": "[email protected]",
"FirstName": "John",
"IsActive": true,
"IsActiveDirectoryUser": false,
"IsAzureAdUser": false,
"Lastname": "D",
"UserId": 5,
"Username": "[email protected]",
"UserStatus": 0
}]
}
Postman Snapshot:
Get Specific User Detail by Email or Username
With this endpoint, users can retrieve specific user details by providing the Email Address or Username in the path parameter.
Method: GET
Request URI: https://{yourdomain}/reporting/api/site/{tenant-name}/v5.0/users/{user}
Example URI: http://localhost:59774/reporting/api/site/site1/v5.0/users/[email protected]
Response:
{
"ContactNumber": "",
"DisplayName": "John D",
"Email": "[email protected]",
"FirstName": "Pravin",
"IsActive": true,
"Lastname": "A",
"UserStatus": 0,
"UserId": 1,
"Username": "[email protected]",
"DirectoryType": 1,
"Avatar": ""
}
Postman Snapshot:
Get Group Details Of Particular User
With this endpoint, administrators can get the group details of particular users from the server by providing email address, or user ID in the path parameter.
Method: GET
Request URI: https://{yourdomain}/reporting/api/site/{tenant-name}/v5.0/users/{user}/groups
Example URI: http://localhost:59774/reporting/api/site/site1/v5.0/users/[email protected]/groups
Response:
{
"GroupList": [
{
"Description": "Has administrative rights for the reports",
"Id": 1,
"IsActiveDirectoryGroup": false,
"IsAzureADGroup": false,
"Name": "System Administrator"
},
{
"Description": "",
"Id": 2,
"IsActiveDirectoryGroup": false,
"IsAzureADGroup": false,
"Name": "ReportServer"
}
]
}
Postman Snapshot:
Summary
This article demonstrated how to manage users in Bold Reports using the REST API v5.0, including user creation, updates, activation/deactivation, deletion, and retrieval of user and group details. These endpoints help automate and simplify user administration tasks.
