Get All Roles - GET /Roles

Get details of all roles.

Usage:

1. GET /Users and get details of all roles
2. PUT /Roles/{id} and update role details

URL

/cxrestapi/auth/Roles

Method:

GET

Media Type (header):

Authorization: Bearer <access token value>
Accept: application/json;v=1.0

Parameters

None

Success Response:

Code: 200 Success

Error Response:

Code: 401 Unauthorized
Code: 403 Forbidden

Sample Response:

[
  {
    "id": 1,
    "isSystemRole": true,
    "name": "Admin",
    "description": "Checkmarx products global administrator",
    "permissionIds": [
      1,
      2,
      3,
      4,
    ]
  },
  {
    "id": 2,
    "isSystemRole": true,
    "name": "Access Control Manager",
    "description": "Manages users, authentication and system settings",
    "permissionIds": [
      1,
      2,
    ]
  },
  {
    "id": 3,
    "isSystemRole": true,
    "name": "User Manager",
    "description": "Manages the users in the system",
    "permissionIds": [
      1
    ]
  },
  {
    "id": 4,
    "isSystemRole": true,
    "name": "SAST Scanner",
    "description": "This role grants permissions to create and manage projects, and run scans",
    "permissionIds": [
      7,
      8,
      10,
    ]
  },
  {
    "id": 5,
    "isSystemRole": true,
    "name": "SAST Reviewer",
    "description": "This role grants \"read only\" permissions to view scan results and generate reports",
    "permissionIds": [
      14,
      15,
      16,
    ]
  }
]

Notes:

Retrieves details of all roles. Permission Id (permissionIds) is used in the Permissions API. If the request fails, it returns an error response.

Send Documentation Feedback - If you have comments about this documentation, you can contact the documentation team by sending your feedback to us. We appreciate your feedback!