Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
/rest/{version}/users/{userId}/role/app
Descriptor | Value |
---|---|
HTTP Method | POST |
Description | Gives the user permissions in the provided role for the specified application. These permissions will add onto any other permissions the user has from their global role, attached groups, and other team/app permissions. |
Required Permission | Manage Users |
Version Introduced | 2.5.1.12 |
Changes in 2.7.5 | Added "testEnvironment", "releaseFrequency", "isInternal", and "policyStatuses" to the REST call response. |
Request Header Parameters
Parameter | Value | Required | Description |
---|---|---|---|
Accept | String | Yes | A value of ‘application/json’ must be provided. |
Request POST Data Parameters
Parameter | Value | Required | Description |
---|---|---|---|
appId | Integer | Yes | The ID of the application to assign permissions for. |
roleId | Integer | Yes | The ID of the role to give the user for that application. |
Sample Call:
Code Block | ||
---|---|---|
| ||
curl -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" --data "appId=1&roleId=3" https://localhost:8443/threadfix/rest/latest/users/2/role/app |
Sample Output:
Code Block | ||
---|---|---|
| ||
{ "message": "", "success": true, "responseCode": -1, "object": { "id": 2, "user": { "id": 2, "name": "mfreeman", "displayName": "Morgan", "type": "LOCAL" }, "organization": { "id": 1, "name": "Example Team" }, "role": null, "accessControlApplicationMaps": [ { "id": 1, "application": { "id": 1, "name": "Example App", "url": null, "applicationCriticality": { "id": 2, "name": "Medium" } }, "policyStatuses": [], "description": null, "releaseFrequency": "UNKNOWN", "testEnvironment": null, "isInternal": false "role": { "id": 3, "displayName": "Developer Role" } } ], "allApps": false } } |
Page Tree | ||
---|---|---|
|