GET api/roles?includeDisabled={includeDisabled}&includeVariants={includeVariants}

Retrieves a list of roles based on the specified filtering options.

Request Information

URI Parameters

Name	Description	Type	Additional information
includeDisabled	If true, disabled roles will be included	boolean	None.
includeVariants	If true, variants of roles will be included.	boolean	None.

Body Parameters

None.

Response Information

Resource Description

On success: HTTP 200 OK with a list of roles. On failure: HTTP 400 Bad Request with a generic error message.

Collection of RoleListDTO

Name	Type	Additional information
RoleID	integer	None.
RoleName	string	None.
ParentRoleID	integer	None.
deleted	boolean	None.

Response Formats

application/json, text/json, application/scim+json

Sample:

[
  {
    "RoleID": 1,
    "RoleName": "sample string 2",
    "ParentRoleID": 3,
    "deleted": true
  },
  {
    "RoleID": 1,
    "RoleName": "sample string 2",
    "ParentRoleID": 3,
    "deleted": true
  }
]