Synq Docs
Management APIRoles

Make a role

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

POST/v1/orgs/{org}/roles

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

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/orgs/string/roles" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "permissions": [      "org.read"    ]  }'
{  "id": "string",  "name": "string",  "system": true,  "permissions": [    "string"  ]}

Change a role PATCH

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`.

Forget a brand’s own app at a sign-in provider DELETE

The brand signs in through the org’s app, else Synq’s. Recorded as `org.updated` (or `brand.updated`). Needs `org.connections.edit`.