Synq Docs
Management APIRoles

Change a role

Its name or permissions (the whole list), at most the caller's own; members with it change with it. Needs `org.members.edit`. Recorded as `role.updated`.

PATCH/v1/orgs/{org}/roles/{role}

Its name or permissions (the whole list), at most the caller's own; members with it change with it. Needs org.members.edit. Recorded as role.updated.

Authorization

bearer
AuthorizationBearer <token>

An org API key (sk_live_…, sk_test_…), or an access token from the Synq issuer (the synq brand, on the accounts host) for this API.

In: header

Path Parameters

org*string
role*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PATCH "https://example.com/v1/orgs/string/roles/string" \  -H "Content-Type: application/json" \  -d '{}'
Empty

List an org's roles GET

The system roles and the org’s own. Needs `org.members.view`.

Make a role POST

Any subset of the permission catalog, at most the caller's own. Needs `org.members.edit`. Recorded as `role.created`.