Custom OAuth2 clients (apps)

Use your own instead of Locoia's OAuth2 clients

Use Cases

When using Embed you might want to take the whitelabeling one step further and display your end users your own OAuth2 setup screen as well as doing actions on behalf of your app (e.g. sending messages as a Slackbot which has the same name as your company).

Also, some Connectors like Snowflake only allow custom OAuth2 clients/apps.

Adding and updating custom OAuth2 clients

Currently, adding custom OAuth2 clients is only possible via API, however extended functionality and setup directly inside the Locoia app are coming soon.

Edit custom auth details

PUT https://api.locoia.com/v1/connectors/{{ connector_id }}/custom_auth

Path Parameters

Name
Type
Description

connector_id*

String

Connector ID

Headers

Name
Type
Description

Authorization*

String

Bearer Token

Request Body

Name
Type
Description

oauth2*

Array

The following parameters need to be part of a dictionary inside the oauth2 array.

client_id*

String

Custom client ID

client_secret*

String

Custom client secret

name*

String

Descriptive name for future reference

scopes

Array

List of scopes that should be used. Omit parameter if regular Connector scopes should be used.

{
  "oauth2": [
    {
      "client_id": "CUSTOM_CLIENT_ID",
      "name": "YOUR_SET_NAME"
    }
  ]
}

Adding custom OAuth2 clients is only supported via the Bearer Token which is used in the Locoia app itself. In order to retrieve it, you have to copy the current Bearer Token from your browser's developer tools.

PreviousHow are API versioning and API updates handeled?NextBuilding Connectors

Last updated