v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB

OAuth 2.0 / OpenID Connect

OAuth 2.0 Authorization Endpoint

Performs Authentication of the End-User by sending the User Agent to the Authorization Server's Authorization Endpoint for Authentication and Authorization, using request parameters defined by OAuth 2.0 RFC-6749 and additional parameters and parameter values defined by OpenID Connect Core 1.0.

This is the version that uses HTTP GET method.

get/restapi/oauth/authorize

Query parameters

client_idstring required

Example:AZwEVwGEcfGet2PCouA7K6

The registered identifier of a client application

response_type'code' required

Determines authorization flow type. The only supported value is code which corresponds to OAuth 2.0 "Authorization Code Flow"

redirect_uristring uri

This is the URI where the Authorization Server redirects the User Agent to at the end of the authorization flow. The value of this parameter must exactly match one of the URIs registered for this client application. This parameter is required if there are more than one redirect URIs registered for the app.

statestring

An opaque value used by the client to maintain state between the request and callback. The authorization server includes this value when redirecting the User Agent back to the client. The parameter SHOULD be used for preventing cross-site request forgery attacks.

scopestring

The list of space separated application permissions (OAuth scopes)

display'page' | 'popup' | 'touch' | 'mobile'

Specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User.

promptstring

Space-delimited, case-sensitive list of ASCII string values that specifies whether the Authorization Server prompts the End-User for re-authentication and consent. The defined values are:

login - RingCentral native login form,
sso - Single Sign-On login form,
consent - form to show the requested scope and prompt user for consent.

Either login or sso (or both) must be specified. The default value is login sso

ui_localesstring

Example:en-US

End-User's preferred languages and scripts for the user interface, represented as a space-separated list of RFC-5646 language tag values, ordered by preference.

If this parameter is provided, its value overrides 'Accept-Language' header value and 'localeId' parameter value (if any)

localeIdstring

Example:en-US

DEPRECATED: ui_locales parameter should be used instead

code_challengestring

The code challenge value as defined by the PKCE specification - RFC-7636 "Proof Key for Code Exchange by OAuth Public Clients"

code_challenge_method'plain' | 'S256'

The code challenge method as defined by the PKCE specification - RFC-7636 "Proof Key for Code Exchange by OAuth Public Clients"

The code challenge method as defined by by the PKCE specification - RFC-7636 "Proof Key for Code Exchange by OAuth Public Clients"

noncestring

String value used to associate a Client session with an ID Token, and to mitigate replay attacks. The value is passed through unmodified from the Authentication Request to the ID Token.

ui_optionsstring

Login form user interface options (space-separated). By default, the UI options that are registered for this client application will be used

login_hintstring

Hint to the Authorization Server about the login identifier the End-User might use to log in.

brand_idstring

Example:1210

RingCentral Brand identifier. If it is not provided in the request, server will try to determine brand from the client application profile.