Get list of roles

GET /api-v1/global/role

Headers

  • TARGET-ORGANIZATION-ID integer(int32)

    ID of organization, for which the operation must be performed

  • WEAL-TOKEN string Required

    API token (can be retrieved from account settings)

Query parameters

  • direction string

    Sorting direction

    Values are ASC or DESC. Default value is ASC.

  • pageNumber integer(int32)

    Page Number

    Default value is 1.

  • sizePerPage integer(int32)

    Size per page

    Default value is 60.

  • sortingField string

    Field to sort by

Responses

  • 200 */*

    OK

    Hide response attributes Show response attributes object
    • description string
    • id integer
    • isDefault boolean
    • name string
    • type string

      Values are ROLE or SUPER_ROLE.
  • 400

    400 Bad Request

  • 401

    401 Unauthorized

  • 403

    403 Access Denied

  • 404

    404 Not Found

  • 500

    500 Internal Server Error

GET /api-v1/global/role 
curl \
 --request GET 'https://wyzio.app/api-v1/global/role' \
 --header "TARGET-ORGANIZATION-ID: 42" \
 --header "WEAL-TOKEN: string"
Response examples (200) 
[
  {
    "description": "string",
    "id": 42,
    "isDefault": true,
    "name": "string",
    "type": "ROLE"
  }
]