v1

latestOpenAPI 3.0.02026-07-24212113249.1 KB

Roles

List roles

get/roles

Query parameters

pageSizenumber

The number of documents that will be returned per page

pagenumber

Page to search. Page numbering starts with 0.

sortBystring

The sort-by field name and order. Format: <field_name>.<asc|desc> (asc for ascending and desc for descending order). If no order is specified, descending order is used.

name__exactstring

Filter by role name.

name__containsstring

Return only roles where the name contains this string.

Headers

organizationstring required

The URL of the end-user web application

Response

Successful resopnse

pageinteger

The current page

pageSizeinteger

The number of objects per page

totalinteger

The total number of objects in the response

pageCountinteger

The total number of pages

pageNumberIsGoodboolean

Page number is valid.

hasPreviousPageboolean

There is a previous page.

hasNextPageboolean

There is a next page.

isFirstPageboolean

This is the first page.

isLastPageboolean

This is the last page.

Example response

{
  "page": 1,
  "pageSize": 20,
  "total": 1,
  "pageCount": 1,
  "pageNumberIsGood": true,
  "isFirstPage": true,
  "isLastPage": true,
  "rows": [
    {
      "permissions": [
        {
          "subject": {
            "id": "896632c05f1a59b6d395b963",
            "fields": [
              "name",
              "address"
            ],
            "entity": "accountstatuses"
          }
        }
      ],
      "name": "DEFAULT-USER",
      "description": "This role allows user basic functionalities",
      "default": true
    }
  ]
}