RingCentral .Net SDK
Properties | List of all members
RingCentral.AuthorizeRequest Class Reference

Properties

string response_type [get, set]
 Determines authorization flow: More...
 
string redirect_uri [get, set]
 This is a callback URI which determines where the response is sent. The value of this parameter must exactly match one of the URIs you have provided for your app upon registration Required Format: uri More...
 
string client_id [get, set]
 Identifier (key) of a client application Required More...
 
string state [get, set]
 Client state. Returned to the client at the end of the flow More...
 
string brand_id [get, set]
 Brand identifier. If it is not provided in request, server will try to determine brand from client app profile. The default value is 1210 - RingCentral US brand ID Default: 1210 More...
 
string display [get, set]
 Style of login form. The default value is 'page'. The 'popup' and 'touch' values are featured for mobile applications Default: page Enum: page, popup, touch, mobile More...
 
string prompt [get, set]
 Specifies which login form will be displayed. Space-separated set of the following values: More...
 
string localeId [get, set]
 Locale code of a language. Overwrites 'Accept-Language' header value. DEPRECATED: ui_locales parameter should be used instead Example: en-US More...
 
string ui_locales [get, set]
 Locale code of a language. Overwrites 'Accept-Language' header value and 'localeId' parameter value Example: en-US More...
 
string ui_options [get, set]
 User interface options (space-separated) More...
 
string scope [get, set]
 OAuth scope More...
 
string accept_language [get, set]
 
string request [get, set]
 
string request_uri [get, set]
 Format: uri More...
 
string nonce [get, set]
 
string code_challenge [get, set]
 
string code_challenge_method [get, set]
 Enum: plain, S256 More...
 

Property Documentation

◆ accept_language

string RingCentral.AuthorizeRequest.accept_language
getset

◆ brand_id

string RingCentral.AuthorizeRequest.brand_id
getset

Brand identifier. If it is not provided in request, server will try to determine brand from client app profile. The default value is 1210 - RingCentral US brand ID Default: 1210

◆ client_id

string RingCentral.AuthorizeRequest.client_id
getset

Identifier (key) of a client application Required

◆ code_challenge

string RingCentral.AuthorizeRequest.code_challenge
getset

◆ code_challenge_method

string RingCentral.AuthorizeRequest.code_challenge_method
getset

Enum: plain, S256

◆ display

string RingCentral.AuthorizeRequest.display
getset

Style of login form. The default value is 'page'. The 'popup' and 'touch' values are featured for mobile applications Default: page Enum: page, popup, touch, mobile

◆ localeId

string RingCentral.AuthorizeRequest.localeId
getset

Locale code of a language. Overwrites 'Accept-Language' header value. DEPRECATED: ui_locales parameter should be used instead Example: en-US

◆ nonce

string RingCentral.AuthorizeRequest.nonce
getset

◆ prompt

string RingCentral.AuthorizeRequest.prompt
getset

Specifies which login form will be displayed. Space-separated set of the following values:

  • 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 Default: login sso

◆ redirect_uri

string RingCentral.AuthorizeRequest.redirect_uri
getset

This is a callback URI which determines where the response is sent. The value of this parameter must exactly match one of the URIs you have provided for your app upon registration Required Format: uri

◆ request

string RingCentral.AuthorizeRequest.request
getset

◆ request_uri

string RingCentral.AuthorizeRequest.request_uri
getset

Format: uri

◆ response_type

string RingCentral.AuthorizeRequest.response_type
getset

Determines authorization flow:

  • code - Authorization Code,
  • token - Implicit Required Enum: code, token

◆ scope

string RingCentral.AuthorizeRequest.scope
getset

OAuth scope

◆ state

string RingCentral.AuthorizeRequest.state
getset

Client state. Returned to the client at the end of the flow

◆ ui_locales

string RingCentral.AuthorizeRequest.ui_locales
getset

Locale code of a language. Overwrites 'Accept-Language' header value and 'localeId' parameter value Example: en-US

◆ ui_options

string RingCentral.AuthorizeRequest.ui_options
getset

User interface options (space-separated)


The documentation for this class was generated from the following file: