Skip to content

Check plugin authorization state

GET /checkAuth

Optional reference path for manifest authStateUrl. The browser calls this URL directly without deliberately attaching a plugin credential or operation-specific user parameter. Shared Axios defaults can nevertheless add ambient App Connect headers such as rc-extension-id, rc-account-id, developer-author-name, and sometimes an App Connect Authorization header. Those ambient values are not a supported plugin authentication contract and must not be trusted or logged. A remote plugin needs its own trusted correlation or session mechanism to report per-user state. The client reads successful and can display returnMessage. Restrict CORS appropriately.

Operation ID: getPluginAuthorizationState
Authorization: None

Responses

Status Description Body
200 Authorization state for the correlated plugin user. The client uses successful and displays optional returnMessage.message and messageType with a fixed 3000 ms duration. PluginAuthStateResponse
500 The plugin could not determine authorization state. The client treats the request as disconnected and displays returnMessage when the error response supplies one.