Synq Docs
Management APIAPI keys

A user's API keys

The keys they made for the brand's APIs (AERO-1693), oldest first, revoked and expired ones too; never a key itself. Needs `org.users.view`.

GET/v1/orgs/{org}/brands/{brand}/users/{user}/api-keys

The keys they made for the brand's APIs (AERO-1693), oldest first, revoked and expired ones too; never a key itself. Needs org.users.view.

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

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/orgs/string/brands/string/users/string/api-keys"
{  "data": [    {      "id": "string",      "name": "string",      "prefix": "string",      "api": {        "identifier": "string",        "name": "string"      },      "scopes": [        "string"      ],      "expires_at": "2019-08-24T14:15:22Z",      "revoked_at": "2019-08-24T14:15:22Z",      "last_used_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z"    }  ]}

List an org's API keys GET

Newest first, revoked ones too; never a key itself. Needs `org.apiKeys.view`.

Make an API key POST

`sk_live_…` in production, `sk_test_…` elsewhere, in this response only. Its permissions are at most the caller's own in the org. Needs `org.apiKeys.edit`. Recorded as `api_key.created`.