RingCentral.AuthorizeRequest Class Reference

Properties
string	response_type [get, set]
	Determines authorization flow type. The only supported value is code which corresponds to OAuth 2.0 "Authorization Code Flow" Required Enum: code.
string	redirect_uri [get, set]
	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. Format: uri.
string	client_id [get, set]
	The registered identifier of a client application Required Example: AZwEVwGEcfGet2PCouA7K6.
string	state [get, set]
	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. Using this parameter is strongly recommended to prevent cross-site request forgery attacks.
string	scope [get, set]
	The list of requested OAuth scopes (space separated).
string	display [get, set]
	Specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User. Default: page Enum: page, popup, touch, mobile.
string	prompt [get, set]
	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:
string	ui_locales [get, set]
	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. Example: en-US.
string	code_challenge [get, set]
	The code challenge value as defined by the PKCE specification - RFC-7636 "Proof Key for Code Exchange by OAuth Public Clients".
string	code_challenge_method [get, set]
	The code challenge method as defined by the PKCE specification - RFC-7636 "Proof Key for Code Exchange by OAuth Public Clients". This parameter is mandatory when the code_challenge is provided Default: plain Enum: plain, S256.
string	nonce [get, set]
	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. (This parameter is defined in OpenID Connect 1.0 specification).
string	login_hint [get, set]
	Hint to the Authorization Server about the login identifier the End-User might use to log in.
string	brand_id [get, set]
	RingCentral Brand identifier. If it is not provided in the request, server will try to determine brand from the client application profile. Example: 1210.

Property Documentation

prompt

string RingCentral.AuthorizeRequest.prompt

getset

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;
• none - indicates that non-interactive authorization is requested (the flow will succeed only if the user has been already authenticated within the same browser session). Cannot be combined with any other prompt option. Default: login sso

---

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

• RingCentral.Net/Definitions/AuthorizeRequest.cs