Synq Docs
Management APIAPIs

Register an API

An API with its own audience: tokens asked for with `resource=<identifier>` name it alone. The OpenID scopes can't be defined. Needs `org.apis.edit`. Recorded as `api.created`.

POST/v1/orgs/{org}/brands/{brand}/apis

An API with its own audience: tokens asked for with resource=<identifier> name it alone. The OpenID scopes can't be defined. Needs org.apis.edit. Recorded as api.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
brand*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

application/problem+json

curl -X POST "https://example.com/v1/orgs/string/brands/string/apis" \  -H "Content-Type: application/json" \  -d '{    "identifier": "string",    "name": "string"  }'
{  "id": "string",  "brand_id": "string",  "identifier": "string",  "name": "string",  "scopes": [    {      "name": "string",      "description": "string"    }  ],  "access_token_ttl": 0,  "allow_third_party": true,  "allow_user_api_keys": true,  "client_id": "string",  "identity_claims": [    "email"  ],  "created_at": "2019-08-24T14:15:22Z"}

Change an API PATCH

Its name, scopes, token lifetime, whether third-party apps may ask for it, and its own client; never its identifier. Needs `org.apis.edit`. Recorded as `api.updated`.

Set which of an API's scopes an app may ask for PUT

An app people sign in to is limited to these; a machine app gets tokens for this API with exactly these, and for no API it isn't given. Needs `org.apps.edit`. Recorded as `app.api_access_changed`.