See the Adding an Authentication guide for an overview of how Authentications work.

To create a new Authentication for a selected App, make a POST request to the /authentications endpoint. This allows your user to securely connect their account to the selected third-party App.

// POST /authentications
{
  "data": {
    "title": "My new auth",
    "app": "8cdbc496-c95c-4f19-b3a3-fee03ed5f924",
    "authentication_fields": {
      "secret": "example_E4CrHVvRuxTXrPFLyyZFeRJwJcx2ELQZ"
    }
  }
}

A successful response will return the newly created Authentication object:

{
  "links": {
    "next": null,
    "prev": null
  },
  "meta": {
    "count": 1,
    "limit": 1,
    "offset": 0
  },
  "data": [
    {
      "type": "authentication",
      "id": "example_DOb4nWkz",
      "app": "8cdbc496-c95c-4f19-b3a3-fee03ed5f924",
      "is_expired": false,
      "title": "My new auth"
    }
  ]
}

This endpoint requires the authentication:write OAuth scope. Authentications are tied to the current user and must be initiated by them.

If you’re unsure which App ID to use when creating an Authentication, first retrieve it from the /apps endpoint.

This API is rate limited.

Was this page helpful?