CRM OAuth callback
GET /oauth-callback
Completes connector OAuth by passing the provider result and connector context to the selected connector, storing the resulting CRM credentials, and issuing an App Connect CRM-session JWT. Browser flows restore context from state or callbackUri. Connector-specific query fields such as account, extension, email, or username can also be forwarded. MCP authorization stores the completed session server-side and returns plain text instead of a browser token.
Operation ID: getOauthCallback
Authorization: None
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
state |
query | string | No | Opaque connector OAuth state. The server and connector use it to restore platform, user, redirect, and anti-forgery context. |
code |
query | string | No | One-time authorization code returned by the CRM OAuth provider. |
callbackUri |
query | string | No | Full browser callback URI containing the CRM provider result. Legacy clients can send provider fields separately when this value is not encoded. |
hostname |
query | string | No | Optional tenant-specific CRM hostname retained through the OAuth flow. |
tokenUrl |
query | string | No | Optional connector-specific OAuth token endpoint retained through the authorization flow. |
apiUrl |
query | string | No | Optional connector-specific CRM API base URL retained through the authorization flow. |
proxyId |
query | string | No | Proxy connector identifier retained through the OAuth exchange. |
rcAccountId |
query | string | No | Optional RingCentral account context forwarded to connectors that bind CRM OAuth to an account. |
rcExtensionId |
query | string | No | Optional RingCentral extension context forwarded to connectors that bind CRM OAuth to a user. |
userEmail |
query | string · email | No | Optional RingCentral user email forwarded to connectors that need it during OAuth completion. |
username |
query | string | No | Optional connector login name used by connectors such as Bullhorn during OAuth completion. |
Responses
| Status | Description | Body |
|---|---|---|
200 |
Successful route-specific JSON response. Consult the operation description for ownership and semantics. | GenericSuccessResponse |
400 |
Bad request, missing authentication, or connector error. | ErrorResponse, string |