Replace a custom role's permissions

Sets the role's grants to exactly the names given: a replacement, not
a merge, so a name left out is revoked and an empty array leaves the
role granting nothing. Requires role:update, and the path tenant
must equal the caller's tenant_id claim.

Only a custom role can be edited (a platform role is 400); another
tenant's role reads as 404. The containment rule applies to what is
newly granted: a permission the role already held stays whether
or not the editor holds it.

Path Params
uuid
required

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

uuid
required

The role. One belonging to another tenant reads as 404, the same as one
that does not exist.

Body Params

The role's whole grant set. A name left out is revoked, so this
replaces rather than merges.

permissions
array of strings
required

The permission names the role should grant. May be empty, which
leaves the role granting nothing.

permissions*
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

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