Skip to content

Get admin-managed API-key auth state

GET /apiKeyManagedAuthState

Derives RingCentral account and extension identity from the supplied RingCentral token and reports whether administrator-managed API-key fields can satisfy the selected connector login. Missing required manual fields and a previous managed-login fallback are returned explicitly. Client-supplied account or extension identifiers are not trusted for this decision.

Operation ID: getApiKeyManagedAuthState
Authorization: API key or API key

Parameters

Name Location Type Required Description
platform query string Yes Connector platform key from the App Connect manifest.
connectorId query string No Private or proxy connector identifier.
isPrivate query boolean No Whether connector-scoped managed credentials should be used.

Responses

Status Description Body
200 Managed API-key field state for the RingCentral user and account. ManagedAuthStateResponse
400 Bad request, missing authentication, or connector error. ErrorResponse, string