Permissions

(i.e., Asset Management, User Accounts Management, Scan Management, etc.)

Quick Navigation

GET Permissions

Purpose

Returns a list of permissions.

Required Permissions

User Accounts Management (Read).

Request Body

None.

Response Body

Content-Type: application/json

[
    {
        PermissionID : int,
        Name : string
    },
    …
]

Response Codes

200 – Request successful. Permissions in the response body.

For more information, please see Common Response Codes.

User Group Permissions

GET UserGroups/{userGroupID}/Permissions

Purpose

Gets all permissions for the user group referenced by ID.

Required Permissions

User Accounts Management (Read).

URL Parameters

userGroupId: ID of the user group.

Request Body

None.

Response Body

Content-Type: application/json

[
    {
        PermissionID : int,
        AccessLevelID : int
    },
…]

Response Codes

200 – Request successful. Permissions in the response body.

For more information, please see Common Response Codes.

POST UserGroups/{userGroupId}/Permissions

Purpose

Sets permissions for the user group referenced by ID.

Required Permissions

User Accounts Management (Read/Write).

Adding the Team Passwords feature/permission to a user group requires the caller to be an administrator.

URL Parameters

userGroupId: ID of the user group.

Request Body

Content-Type: application/json

[
    {
        PermissionID : int,
        AccessLevelID : int
    },
    …
]

Response Body

None.

Response Codes

204 – Request successful. No content in body.

For more information, please see Common Response Codes.

DELETE UserGroups/{userGroupId}/Permissions

Purpose

Deletes all permissions for the user group referenced by ID.

Required Permissions

User Accounts Management (Read/Write).

Removing the Team Passwords feature/permission from a user group requires the caller to be an administrator.

URL Parameters

userGroupId: ID of the user group.

Request Body

None.

Response Body

None.

Response Codes

200 – Request successful.

For more information, please see Common Response Codes.