Start plugin OAuth flow

POST

/api/v1/plugin-system/oauth/start

const url = 'https://example.com/api/v1/plugin-system/oauth/start';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"pluginId":"example","instanceId":"example","authContext":"example","redirectUri":"https://example.com"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/v1/plugin-system/oauth/start \
  --header 'Content-Type: application/json' \
  --data '{ "pluginId": "example", "instanceId": "example", "authContext": "example", "redirectUri": "https://example.com" }'

Creates an OAuth authorization URL for a plugin instance.

Request Body^required

application/json

object

pluginId

required

string

instanceId

required

string

authContext

string

redirectUri

required

string format: uri

Example^generated

{
  "pluginId": "example",
  "instanceId": "example",
  "authContext": "example",
  "redirectUri": "https://example.com"
}

Responses

200

OAuth authorization URL

application/json

object

url

string format: uri

state

string

instanceId

string

Example^generated

{
  "url": "https://example.com",
  "state": "example",
  "instanceId": "example"
}

400

Bad Request

401

Unauthorized

500

Internal Server Error

Start plugin OAuth flow

Request Bodyrequired

Examplegenerated

Responses

200

Examplegenerated

400

401

500

Request Body^required

Example^generated

Example^generated