Package com.ringcentral.definitions

Class GetTokenRequest

java.lang.Object
com.ringcentral.definitions.GetTokenRequest
public class GetTokenRequest extends Object
Token endpoint request parameters used in the "Guest" authorization flow with the `guest` grant type

  • Field Details

    • client_id

      public String client_id
      The registered identifier of a client application. Used to identify a client ONLY if the client authentication is not required and corresponding credentials are not provided with this request Example: AZwEVwGEcfGet2PCouA7K6

    • client_assertion_type

      public String client_assertion_type
      Client assertion type for the `client_secret_jwt` or `private_key_jwt` client authentication types, as defined by [RFC-7523](https://datatracker.ietf.org/doc/html/rfc7523#section-2.2). This parameter is mandatory if the client authentication is required and a client decided to use one of these authentication types Enum: urn:ietf:params:oauth:client-assertion-type:jwt-bearer

    • client_assertion

      public String client_assertion
      Client assertion (JWT) for the `client_secret_jwt` or `private_key_jwt` client authentication types, as defined by [RFC-7523](https://datatracker.ietf.org/doc/html/rfc7523#section-2.2). This parameter is mandatory if the client authentication is required and a client decided to use one of these authentication types

    • scope

      public String scope
      The list of application permissions (OAuth scopes) requested. By default, it includes all permissions configured on the client application registration

    • endpoint_id

      public String endpoint_id
      The unique identifier of a client application instance. If not specified, the derived or auto-generated value will be used

    • access_token_ttl

      public Long access_token_ttl
      Access token lifetime in seconds Maximum: 3600 Minimum: 600 Format: int32 Default: 3600

    • refresh_token_ttl

      public Long refresh_token_ttl
      Refresh token lifetime in seconds Maximum: 2592000 Format: int32 Default: 604800

    • grant_type

      public String grant_type
      Grant type Required Enum: authorization_code, urn:ietf:params:oauth:grant-type:jwt-bearer, partner_jwt, refresh_token, password, ivr_pin, urn:ietf:params:oauth:grant-type:device_code, client_credentials, otp, guest

    • code

      public String code
      For `otp` grant type only. One-time password code Required

    • redirect_uri

      public String redirect_uri
      For `authorization_code` grant type only. 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 Format: uri

    • code_verifier

      public String code_verifier
      For `authorization_code` grant type only. The code verifier as defined by the PKCE specification - [RFC-7636 "Proof Key for Code Exchange by OAuth Public Clients"](https://datatracker.ietf.org/doc/html/rfc7636)

    • assertion

      public String assertion
      For `urn:ietf:params:oauth:grant-type:jwt-bearer` or `partner_jwt` grant types only. Authorization grant assertion (JWT) as defined by [RFC-7523](https://datatracker.ietf.org/doc/html/rfc7523#section-2.1). Required

    • refresh_token

      public String refresh_token
      For `refresh_token` grant type only. Previously issued refresh token. Required

    • username

      public String username
      For `password` grant type only. User login name: email or phone number in E.164 format Required

    • password

      public String password
      For `password` grant type only. User's password Required Format: password

    • extension

      public String extension
      For `password` grant type only. Optional. Extension short number. If a company number is specified as a username, and extension is not specified, the server will attempt to authenticate client as main company administrator

      DEPRECATED: use extension number embedded into username string like `+16501234567*101`

    • pin

      public String pin
      IVR pin for pin-based authentication.

      DEPRECATED: use a dedicated `ivr_pin` grant type instead

    • ivr_pin

      public String ivr_pin
      For `ivr_pin` grant type only. User's IVR pin. Required

    • device_code

      public String device_code
      For `urn:ietf:params:oauth:grant-type:device_code` grant type only. The device verification code as defined by [RFC-8628](https://datatracker.ietf.org/doc/html/rfc8628#section-3.4) Required

    • brand_id

      public String brand_id
      RingCentral Brand identifier. Required

    • account_id

      public String account_id
      RingCentral internal account ID Required

    • partner_account_id

      public String partner_account_id
      The ID of the account on RingCentral partner's side Required

    • resource_type

      public String resource_type
      Resource type for the guest access. Required

    • resource

      public String resource
      Resource URL for the guest access. Required

  • Constructor Details

    • GetTokenRequest

      public GetTokenRequest()

  • Method Details