Package com.ringcentral.definitions

Class AuthorizeRequest

java.lang.Object

com.ringcentral.definitions.AuthorizeRequest

public class AuthorizeRequest
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
String	accept_language
String	brand_id	Brand identifier.
String	client_id	Identifier (key) of a client application Required
String	code_challenge
String	code_challenge_method	Enum: plain, S256
String	display	Style of login form.
String	localeId	Locale code of a language.
String	nonce
String	prompt	Specifies which login form will be displayed.
String	redirect_uri	This is a callback URI which determines where the response is sent.
String	request
String	request_uri	Format: uri
String	response_type	Determines authorization flow: - **code** - Authorization Code, - **token** - Implicit Required Enum: code, token
String	scope	OAuth scope
String	state	Client state.
String	ui_locales	Locale code of a language.
String	ui_options	User interface options (space-separated)

Constructor Summary

Constructors

Constructor	Description
AuthorizeRequest()

Method Summary

Modifier and Type	Method	Description
AuthorizeRequest	accept_language(String accept_language)
AuthorizeRequest	brand_id(String brand_id)
AuthorizeRequest	client_id(String client_id)
AuthorizeRequest	code_challenge(String code_challenge)
AuthorizeRequest	code_challenge_method(String code_challenge_method)
AuthorizeRequest	display(String display)
AuthorizeRequest	localeId(String localeId)
AuthorizeRequest	nonce(String nonce)
AuthorizeRequest	prompt(String prompt)
AuthorizeRequest	redirect_uri(String redirect_uri)
AuthorizeRequest	request(String request)
AuthorizeRequest	request_uri(String request_uri)
AuthorizeRequest	response_type(String response_type)
AuthorizeRequest	scope(String scope)
AuthorizeRequest	state(String state)
AuthorizeRequest	ui_locales(String ui_locales)
AuthorizeRequest	ui_options(String ui_options)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

response_type

public String response_type

Determines authorization flow: - **code** - Authorization Code, - **token** - Implicit Required Enum: code, token

redirect_uri

public String redirect_uri

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

client_id

public String client_id

Identifier (key) of a client application Required

state

public String state

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

brand_id

public String brand_id

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

display

public String display

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

prompt

public String prompt

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

localeId

public String localeId

Locale code of a language. Overwrites 'Accept-Language' header value.

DEPRECATED: `ui_locales` parameter should be used instead Example: en-US

ui_locales

public String ui_locales

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

ui_options

public String ui_options

User interface options (space-separated)

scope

public String scope

OAuth scope

accept_language

public String accept_language

request

public String request

request_uri

public String request_uri

Format: uri

nonce

public String nonce

code_challenge

public String code_challenge

code_challenge_method

public String code_challenge_method

Enum: plain, S256

Constructor Details

AuthorizeRequest

public AuthorizeRequest()

Method Details

response_type

public AuthorizeRequest response_type(String response_type)

redirect_uri

public AuthorizeRequest redirect_uri(String redirect_uri)

client_id

public AuthorizeRequest client_id(String client_id)

state

public AuthorizeRequest state(String state)

brand_id

public AuthorizeRequest brand_id(String brand_id)

display

public AuthorizeRequest display(String display)

prompt

public AuthorizeRequest prompt(String prompt)

localeId

public AuthorizeRequest localeId(String localeId)

ui_locales

public AuthorizeRequest ui_locales(String ui_locales)

ui_options

public AuthorizeRequest ui_options(String ui_options)

scope

public AuthorizeRequest scope(String scope)

accept_language

public AuthorizeRequest accept_language(String accept_language)

request

public AuthorizeRequest request(String request)

request_uri

public AuthorizeRequest request_uri(String request_uri)

nonce

public AuthorizeRequest nonce(String nonce)

code_challenge

public AuthorizeRequest code_challenge(String code_challenge)

code_challenge_method

public AuthorizeRequest code_challenge_method(String code_challenge_method)