Package com.ringcentral.definitions

Class AuthorizeParameters

java.lang.Object
com.ringcentral.definitions.AuthorizeParameters
public class AuthorizeParameters extends Object
Query parameters for operation authorize

  • Field Details

    • client_id

      public String client_id
      The registered identifier of a client application Example: AZwEVwGEcfGet2PCouA7K6

    • response_type

      public String response_type
      Determines authorization flow type. The only supported value is `code` which corresponds to OAuth 2.0 "Authorization Code Flow" Enum: code

    • redirect_uri

      public String redirect_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. Format: uri

    • state

      public String state
      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.

    • scope

      public String scope
      The list of space separated application permissions (OAuth scopes)

    • display

      public String display
      Specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User. Default: page Enum: page, popup, touch, mobile

    • prompt

      public String prompt
      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

    • ui_locales

      public String ui_locales
      End-User's preferred languages and scripts for the user interface, represented as a space-separated list of [RFC-5646](https://datatracker.ietf.org/doc/html/rfc5646) language tag values, ordered by preference. Example: en-US

    • code_challenge

      public String code_challenge
      The code challenge value as defined by the PKCE specification - [RFC-7636 "Proof Key for Code Exchange by OAuth Public Clients"](https://datatracker.ietf.org/doc/html/rfc7636)

    • code_challenge_method

      public String code_challenge_method
      The code challenge method as defined by the PKCE specification - [RFC-7636 "Proof Key for Code Exchange by OAuth Public Clients"](https://datatracker.ietf.org/doc/html/rfc7636). This parameter is mandatory when the `code_challenge` is provided Default: plain Enum: plain, S256

    • nonce

      public String nonce
      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)

    • login_hint

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

    • brand_id

      public String brand_id
      RingCentral Brand identifier. If it is not provided in the request, server will try to determine brand from the client application profile. Example: 1210

  • Constructor Details

    • AuthorizeParameters

      public AuthorizeParameters()

  • Method Details