Synq Docs
Management APIAPIs

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

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

PUT/v1/orgs/{org}/brands/{brand}/apps/{app}/apis/{api}

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.

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
app*string

The app's client_id

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

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

Delete an app DELETE

At once: it signs no one in and gets no tokens. An app an API names as its own client can't be deleted until the API names another. Needs `org.apps.edit`. Recorded as `app.deleted`.