Synq Docs
Management APIAPIs

Change an API

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

PATCH/v1/orgs/{org}/brands/{brand}/apis/{api}

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.

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
api*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 PATCH "https://example.com/v1/orgs/string/brands/string/apis/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "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"}

Which of the brand's APIs an app is limited to GET

The scopes of each API the app may ask for. An app people sign in to may ask for any scope of an API not listed; a machine app, only for those listed. Needs `org.apps.view`.

Register an API POST

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