Validate plugin session auth

POST

/api/v1/plugin-system/auth/validate

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

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/auth/validate \
  --header 'Content-Type: application/json' \
  --data '{ "pluginId": "example", "instanceId": "example", "authContext": "example", "auth": { "additionalProperty": "example" } }'

Validates session-style plugin credentials before saving them.

Request Body^required

application/json

object

pluginId

required

string

instanceId

string

authContext

string

auth

required

object

key

additional properties

string

Example^generated

{
  "pluginId": "example",
  "instanceId": "example",
  "authContext": "example",
  "auth": {
    "additionalProperty": "example"
  }
}

Responses

200

Auth validation result

application/json

object

boolean

authContext

string

Example^generated

{
  "ok": true,
  "authContext": "example"
}

400

Bad Request

401

Unauthorized

500

Internal Server Error

Validate plugin session auth

Request Bodyrequired

Examplegenerated

Responses

200

Examplegenerated

400

401

500

Request Body^required

Example^generated

Example^generated