/roles

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

x-account-id header string

Account ID for the request

Click here to view an exhaustive list of all available parameters

get-detailed query boolean

Return detailed information about roles.

Output:

A list of roles

[
  {
    "id": 0,
    "role": "string",
    "users": [
      "string"
    ],
    "permissions": [
      "string"
    ]
  }
]

in: header
name: x-account-id
schema:
  type: string
description: Account ID for the request
required: true
example: "2311"

|
export type xAccountIdHeader = any; // Schema type not fully supported

Check out the source code for this route entrypoint here: /roles/route.ts

Or the swagger.yaml spec this documentation was generated from: /roles/swagger.yaml