API overview
API Reference
  1. Quant Flow API
  2. Roles

List roles

get
https://api.qfp.quantnetwork.net/api/tenants//roles

One page of the roles this tenant may assign, each with the flat set
of permission names it grants. The path tenant must equal the
caller's tenant_id claim; a mismatch is 403. No permission is
required.

custom tells the platform roles (SUPER_ADMIN, ADMIN, USER,
shared by every tenant and not editable) from this tenant's own;
another tenant's custom roles never appear. search matches the name
and description, case-insensitively. Ordering defaults to name,asc.

Path Params
uuid
required

The tenant. Must equal the caller's tenant_id claim; a mismatch is
403 Invalid tenant id.

Query Params

Substring to match against the role name and description.

integer
≥ 0
Defaults to 0

Zero-based page index.

integer
≥ 1
Defaults to 20
sort
array of strings

Sort order, as property or property,(asc|desc), repeatable.
Sortable properties: name, description, createdAt, updatedAt,
id. Defaults to name,asc. An unknown property surfaces as a 500.

sort
Headers
string
required
^\d+\.\d+\.\d+$

The version of the Quant Flow API the request follows, as major.minor.patch (for example 1.0.0). The request is interpreted, and the response shaped, according to that version.

Responses

Updated 28 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 28 days ago

Did this page help you?