Create a custom role

post

https://api.qfp.quantnetwork.net/api/tenants/{id}/roles

Defines a role owned by the caller's own tenant, granting the named
permissions. Requires role:create, and the path tenant must equal
the caller's tenant_id claim. A caller may not grant a permission
they do not hold themselves; the names to pick from are the catalog
at GET /api/permissions.

The trimmed name must be free: a platform role name or one already
used by this tenant is 409, compared case-insensitively. Returns
200, not 201.

Path Params

uuid

required

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

Body Params

name

string

required

length between 1 and 50

Trimmed. Unique per tenant and not one of the platform role names,
both compared case-insensitively; either clash is 409.

description

string | null

Trimmed; a blank value is stored as null.

permissions

array of strings

required

The permission names to grant, from the catalog at
GET /api/permissions. Required, though it may be empty. Blank
entries are dropped and the rest trimmed; a name not in the catalog
is 400.

permissions*

Headers

API-Version

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

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The created role, custom true.

400name is blank or longer than 50 characters, permissions is absent, or a name in it is not in the catalog (Unknown permissions: {names}.).

401No bearer token, or a token that failed verification. Always Authentication token is missing or invalid.; the reason is never disclosed.

403No role:create permission (You do not have permission to create roles.), the path tenant is not the caller's own (Invalid tenant id), or the role would grant a permission the caller does not hold (You cannot grant permissions you do not hold yourself: {names}.).

404No tenant with this id exists.

409The name is reserved by the platform, or already used by this tenant.