Skip to content

Register a RingCentral account

POST /admin/register

Required reference operation for manifest userRegisterEndpointUrl. After App Connect validates the installing administrator, it sends the RingCentral access token and rcAccountId to the configured URL; pluginId is not included in the JSON body. The plugin server must independently validate the token with RingCentral, confirm that its account matches rcAccountId, and issue a non-empty account-scoped bearer credential in jwtToken. A host serving multiple plugins must derive plugin identity from the configured URL or trusted server configuration. The unmodified template reads req.params.pluginId even though its route has no :pluginId parameter, so adapt it before relying on plugin-id claims. App Connect treats jwtToken as opaque and stores it for protected provider calls. Never log or retain the RingCentral access token.

Operation ID: registerPluginAccount
Authorization: None

Request body

Secret RingCentral access token plus the claimed account ID for one plugin registration. No plugin ID is included; bind plugin identity from the configured endpoint or trusted server configuration.

Required: Yes

Content type: application/json

Schema: PluginRegistrationRequest

{
  "rcAccessToken": "ringcentral-admin-access-token",
  "rcAccountId": "123456789"
}

Responses

Status Description Body
200 The RingCentral account was validated and a non-empty plugin bearer credential was issued. PluginRegistrationResponse
400 The JSON body was invalid, the RingCentral access token was missing or rejected, or RingCentral identity lookup failed. TextError
403 The validated RingCentral identity does not belong to rcAccountId. TextError