Create a Connection

post

https://tenants-gateway-api-sbx.sidedrawersbx.com/api/v1/developers/tenant/tenant-id/{tenantId}/connections

Creates a Connection.

Path Params

tenantId

string

required

Tenant identifier.

Body Params

name

string

required

length between 1 and 100

Human-readable name for the connection.

brandCode

string

length between 2 and 20

The affiliate code (brandCode) is an identifier for the "brand" or "affiliate" within a Tenant. The affiliate code is the version of the brand name that appears in the URL. A brand name may be "Corporate ABC", for example. Then the affiliate code might be something like "corporate-abc".

connectionType

string

enum

Defaults to client_credentials

Type of OAuth2 flow or authentication method to use.

Allowed:

identityProvider

string

enum

Defaults to keycloak

Identity provider used. Default: Auth0.

Allowed:

method

string

enum

HTTP method used for token requests (typically POST).

Allowed:

clientId

string

length between 1 and 255

Client identifier or App Key provided by the service for OAuth2 authentication.

clientSecret

string

length between 1 and 255

Client Secret or App Secret provided by the service. This will be encrypted at rest.

tokenUrl

uri

OAuth2 token endpoint URL where access tokens are requested.

scope

string

length ≤ 500

OAuth2 scope parameter defining the level of access requested.

customParams

object

Additional OAuth2 parameters that may be required by specific providers.

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The Connection has been successfully created.