Skip to content

Create a plugin authorization URL

GET /authUrl

Optional reference path for manifest authorizationUrl. The browser client directly calls authorizationUrl with pluginId as an untrusted routing hint; no plugin bearer credential is intentionally supplied. Shared Axios defaults can nevertheless add ambient RingCentral identity headers and sometimes an App Connect Authorization header; these values are not a supported plugin authentication contract and must not be trusted or logged. Return the provider URL as an object containing authUrl. For compatibility, the client also accepts a bare URL string. The provider URL must redirect to the App Connect extension URI and include state with from=plugin, the plugin callback URL in redirectTo, and plugin-generated anti-CSRF correlation that the callback validates. Restrict CORS to the supported extension origin and required headers.

Operation ID: getPluginAuthorizationUrl
Authorization: None

Parameters

Name Location Type Required Description
pluginId query string Yes Developer Console plugin identifier appended by the browser client to authorizationUrl. It is an untrusted routing hint and is not proof of user, account, or plugin-server authorization.

Responses

Status Description Body
200 Preferred response is a JSON object containing authUrl; the current client also accepts a bare URL string for compatibility. one of: PluginAuthUrlResponse, string · uri, string · uri
400 The plugin could not create an authorization URL.
500 The plugin authorization provider was unavailable.