POST
/
o
/
{organisation_id}
/
connectors
/
{connector_id}
/
oauth2
/
initialise
Initialise OAuth 2.0 Connection
curl --request POST \
  --url https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/oauth2/initialise \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "credential": {
    "id": "<string>",
    "organisationId": "<string>"
  },
  "authorizeUrl": "<string>",
  "clientId": "<string>",
  "scopes": [
    "<string>"
  ],
  "disableOfflineAccess": true,
  "prompt": "<string>",
  "additionalParams": "<string>"
}'
{
  "url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication used by the Versori Platform. External consumers must provide an API key, however internal consumers must provide a JWT id_token issued by our IdP.

Path Parameters

​
organisation_id
string<ulid>
required
​
connector_id
string<ulid>
required

ID is the unique identifier of the Connector.

Body

application/json

InitialiseOAuth2ConnectionRequest is the payload to initialise an OAuth 2.0 connection.

Response

200
application/json

OK

InitialiseOAuth2ConnectionResponse contains the URL to redirect the user to in order to initiate an OAuth 2.0 authorization_code grant flow.