User Management
User Management operations
Available API Paths
- /api/user-management/roles
- /api/user-management/users
- /api/user-management/users/{userName}
- /api/user-management/groups
- /api/user-management/groups/{groupName}
- /api/user-management/groups/user/{userName}
Path: /api/user-management/roles
Methods
GET
Retrieve all possible roles in the system. Must be admin to access
Responses
Status | Description | Response Content or Scheme |
200 | An array of existing MMC roles |
Example
[
"admin",
"editor",
"viewer",
"connectionManager",
"monitoringViewer"
]
Status | Description | Response Content or Scheme |
401 | Access to resource is denied. User not authenticated (logged in) or session expired |
|
403 | User does not have enough permissions to access the resource |
|
404 | Plugin is not enabled or not found |
|
500 | An internal server error has occured |
|
Path: /api/user-management/users
Methods
GET
Retrieve all users. Must be admin to access
Responses
Status | Description | Response Content or Scheme |
200 | An array of all the users | |
401 | Access to resource is denied. User not authenticated (logged in) or session expired |
|
403 | User does not have enough permissions to access the resource |
|
404 | Plugin is not enabled or not found |
|
500 | An internal server error has occured |
|
POST
Create a new user. Must be admin to access
Parameters
Name | Required | Type | Request Properties or Schema |
body | true | object | undefined. |
body | true | object | undefined. |
Responses
Status | Description | Response Content or Scheme |
200 | An array of all the users | |
400 | Request data is invalid |
|
401 | Access to resource is denied. User not authenticated (logged in) or session expired |
|
403 | User does not have enough permissions to access the resource |
|
404 | Plugin is not enabled or not found |
|
409 | Requested entity already exists |
|
500 | An internal server error has occured |
|
Path: /api/user-management/users/{userName}
Methods
GET
Retrieve a user by username. Must be admin to access
Parameters
Name | Location | Type | Required | Description |
---|---|---|---|---|
userName | path | string | true | Username of the user to retrieve |
Responses
Status | Description | Response Content or Scheme |
200 | User object corresponding to userName | |
401 | Access to resource is denied. User not authenticated (logged in) or session expired |
|
403 | User does not have enough permissions to access the resource |
|
404 | Plugin is not enabled or not found |
|
410 | Requested entity does not exists or was removed |
|
500 | An internal server error has occured |
|
PUT
Update a user by username. Must be admin to access
Parameters
Name | Location | Type | Required | Description |
---|---|---|---|---|
userName | path | string | true | Username of the user to update |
Parameters
Name | Required | Type | Request Properties or Schema |
body | true | object | undefined. |
body | true | object | undefined. |
Responses
Status | Description | Response Content or Scheme |
200 | An array of all the users | |
400 | Request data is invalid |
|
401 | Access to resource is denied. User not authenticated (logged in) or session expired |
|
403 | User does not have enough permissions to access the resource |
|
404 | Plugin is not enabled or not found |
|
410 | Requested entity does not exists or was removed |
|
500 | An internal server error has occured |
|
DELETE
Delete a user by username. Must be admin to access
Parameters
Name | Location | Type | Required | Description |
---|---|---|---|---|
userName | path | string | true | Username of the user to delete |
Responses
Status | Description | Response Content or Scheme |
200 | An array of all the users | |
401 | Access to resource is denied. User not authenticated (logged in) or session expired |
|
403 | User does not have enough permissions to access the resource |
|
404 | Plugin is not enabled or not found |
|
410 | Requested entity does not exists or was removed |
|
500 | An internal server error has occured |
|
Path: /api/user-management/groups
Methods
GET
Retrieve all user groups. Must be admin to access
Responses
Status | Description | Response Content or Scheme |
200 | A map of all user group names to user group objects | |
401 | Access to resource is denied. User not authenticated (logged in) or session expired |
|
403 | User does not have enough permissions to access the resource |
|
404 | Plugin is not enabled or not found |
|
500 | An internal server error has occured |
|
POST
Create a new user group
Parameters
Name | Required | Type | Request Properties or Schema |
body | true | object | undefined. |
body | true | object | undefined. |
Responses
Status | Description | Response Content or Scheme |
200 | A map of all user group names to user group objects | |
400 | Request data is invalid |
|
401 | Access to resource is denied. User not authenticated (logged in) or session expired |
|
403 | User does not have enough permissions to access the resource |
|
404 | Plugin is not enabled or not found |
|
409 | Requested entity already exists |
|
500 | An internal server error has occured |
|
Path: /api/user-management/groups/{groupName}
Methods
GET
Retrieve a group by group name. Must be admin to access
Parameters
Name | Location | Type | Required | Description |
---|---|---|---|---|
groupName | path | string | true | Name of the group to retrieve |
Responses
Status | Description | Response Content or Scheme |
200 | User group object corresponding to groupName | |
401 | Access to resource is denied. User not authenticated (logged in) or session expired |
|
403 | User does not have enough permissions to access the resource |
|
404 | Plugin is not enabled or not found |
|
410 | Requested entity does not exists or was removed |
|
500 | An internal server error has occured |
|
PUT
Update a group by group name. Must be admin to access
Parameters
Name | Location | Type | Required | Description |
---|---|---|---|---|
groupName | path | string | true | Name of the group to update |
Parameters
Name | Required | Type | Request Properties or Schema |
body | true | object | undefined. |
body | true | object | undefined. |
Responses
Status | Description | Response Content or Scheme |
200 | A map of all user group names to user group objects | |
400 | Request data is invalid |
|
401 | Access to resource is denied. User not authenticated (logged in) or session expired |
|
403 | User does not have enough permissions to access the resource |
|
404 | Plugin is not enabled or not found |
|
410 | Requested entity does not exists or was removed |
|
500 | An internal server error has occured |
|
DELETE
Delete a group by group name. Must be admin to access
Parameters
Name | Location | Type | Required | Description |
---|---|---|---|---|
groupName | path | string | true | Name of the group to delete |
Responses
Status | Description | Response Content or Scheme |
200 | A map of all user group names to user group objects | |
401 | Access to resource is denied. User not authenticated (logged in) or session expired |
|
403 | User does not have enough permissions to access the resource |
|
404 | Plugin is not enabled or not found |
|
410 | Requested entity does not exists or was removed |
|
500 | An internal server error has occured |
|
Path: /api/user-management/groups/user/{userName}
Methods
GET
Retrieve groups of a user you are logged in as. User must also be an admin
Parameters
Name | Location | Type | Required | Description |
---|---|---|---|---|
userName | path | string | true | Username of the user to retrieve groups for |
Responses
Status | Description | Response Content or Scheme |
200 | An array of groups of the specified user |
|
Example
{
"groups": [
{
"name": "testGroup",
"addedBy": {
"username": "cedalo"
}
}
]
}
Status | Description | Response Content or Scheme |
401 | Access to resource is denied. User not authenticated (logged in) or session expired |
|
403 | User does not have enough permissions to access the resource |
|
404 | Plugin is not enabled or not found |
|
500 | An internal server error has occured |
|