Users v3 APIs
The Users v3 APIs allow you to perform various operations to user profiles configured under User Management in the system. Browse through the following APIs to perform required operations to user profiles:
Get All Users
This API retrieves the list of all user profiles in Applications Manager.
Syntax
https://[HOST]:[PORT]/api/v3/users
Header:
authorization=[YOUR_API_KEY]
Supported HTTP methods: GET
Allowed roles: Administrator, User
Sample Request
https://[HOST]:[PORT]/api/v3/users
Header:
authorization=c3d0530476e7eb7fbc5345ebea3a89de
Sample Response
{
"message": "success",
"data": [
{
"id": 1,
"name": "admin",
"emailId": "admin@example.com",
"description": "Default Administrator",
"role": "Super Admin",
"userImage": "/images/user/admin.png",
"userStatus": "Active",
"authentication": "Local Authentication",
"domainName": "",
"userGroup": [
"Network Team",
"Server Admins"
],
"monitorGroup": [
"Production Servers",
"Database Monitors"
],
"activeSessions": 2,
"lastLoginTime": "Mar 16,2026 10:30:45 AM",
"previousLoginTime": "Mar 15,2026 09:15:30 AM"
},
{
"id": 2,
"name": "john.doe",
"emailId": "john.doe@example.com",
"description": "Operator user",
"role": "Operator",
"userImage": "/images/user/john.png",
"userStatus": "Active",
"authentication": "Domain Authentication",
"domainName": "corp.example.com",
"userGroup": [
"Network Team"
],
"monitorGroup": [
"Web Servers"
],
"activeSessions": 0,
"lastLoginTime": "Mar 14,2026 02:20:10 PM",
"previousLoginTime": "Mar 12,2026 11:00:00 AM"
}
],
"meta": {}
}
Update User Status
This API activates or deactivates (locks/unlocks) a user account in Applications Manager.
Syntax:
https://[APM-HOST]:[APM-PORT]/api/v3/users/{userProfileId}/status
Supported HTTP methods: PUT
Allowed Roles: Administrator
API Parameters:
| Parameter | Type | Required | Description |
|---|
| Path Parameter |
userProfileId | Long | Yes | The unique ID of the user |
| Request Parameter |
userStatus | String | Yes | New status value. Allowed: Active, InActive |
Sample Request:
https://apm-prod-server:8443/api/v3/users/2/status?userStatus=InActive
Header:
authorization=c3d0530476e7eb7fbc5345ebea3a89de
Sample Response:
{
"message": "success",
"data": [
"am.webclient.user.status.success.text"
],
"meta": {}
}
Delete a User
Deletes a single user by their profile ID.
Syntax
https://[APM-HOST]:[APM-PORT]/api/v3/users/{userProfileId}
Supported HTTP methods: DELETE
Allowed Roles: Administrator
API Parameters:
| Parameter | Type | Required | Description |
|---|
| Path Parameter |
userProfileId | Long | Yes | The unique ID of the user |
Sample Request:
https://https://apm-prod-server:8443/api/v3/api/v3/users/5
Header:
authorization=c3d0530476e7eb7fbc5345ebea3a89de
Sample Response (200 OK):
{
"message": "success",
"data": [
"user.deletion.success"
],
"meta": {}
}
Delete Multiple Users
Deletes multiple users at once using comma-separated user profile IDs.
Syntax
https://[APM-HOST]:[APM-PORT]/api/v3/users
Supported HTTP methods: DELETE
Allowed Roles: Administrator
Content-Type:application/x-www-form-urlencoded
API Parameters:
| Parameter | Type | Required | Description |
|---|
| Request Parameter |
userProfileIds | String | Yes | Comma-separated list of user profile IDs |
Sample Request:
https://apm-prod-server:8443/api/v3/users
Header:
authorization=c3d0530476e7eb7fbc5345ebea3a89de
Body (form-urlencoded):
userProfileIds=3,5,7
Sample Response (200 OK):
{
"message": "success",
"data": [
"user.deletion.success"
],
"meta": {}
}
