Update role

Updates the specified custom role.

Caution: You must include the toggle privilege for an application alongside any other privilege for that application. For example, to assign WAS.SCAN_WAS.READ, you must also assign WAS.TOGGLE_WAS.USE. If you omit it, the request fails with a 400 response and an Invalid role_permission_string error. Where a category within an application has its own toggle privilege, such as VM.VM_SCAN.TOGGLE_VM_SCAN.USE, you do not need to assign it: Tenable adds it for you.

Requires the Administrator [64] user role or the PS.ACCT_MGMT.AM_ACCESS_CONTROL.EDIT custom role privilege. See Roles.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Specifies the unique identifier (UUID) of the role.

Body Params
string

Specifies the updated name for the role.

string

Specifies the updated description for the role.

role_permission_strings
array of strings

Specifies the custom role privilege strings to assign to the role. This replaces the existing permission set. For a list of supported permission strings, use the List role permissions endpoint. Each privilege category has a toggle privilege that you must include alongside the other privileges in that category, for example WAS.TOGGLE_WAS.USE for Web App Scanning privileges. For more information, see Roles.

role_permission_strings
string

Specifies the role type.

string

Specifies the status of the role. Supported values are ENABLED and DISABLED.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

403

Returned if you do not have permission to update roles. For more information, see Roles and Permissions.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/html