a13nDocs
API referenceConnections

Authorize Connection

A browser flow needs a login session and is bound to this browser by a cookie the callback checks; an API key authorizes only a client-credentials client, without a browser.

POST/api/v1/connections/{connection_id}/authorize

A browser flow needs a login session and is bound to this browser by a cookie the callback checks; an API key authorizes only a client-credentials client, without a browser.

Authorization

AuthorizationBearer <token>

A workspace API key (a13n_...)

In: header

Path Parameters

connection_id*Connection Id

Header Parameters

If-Match?|

The resource's ETag: "{id}:{version}" of its current view, "{key}:{version}" for a model

X-Workspace-ID?|

The workspace ID a login session acts in; required with a login session. An API key acts in its own workspace and needs none; naming another is forbidden.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/connections/string/authorize" \  -H "Content-Type: application/json" \  -d '{}'
{  "expires_at": "2019-08-24T14:15:22Z",  "redirect_url": "string"}