Package com.ringcentral.definitions

Class PublicGetTokenRequest

java.lang.Object

com.ringcentral.definitions.PublicGetTokenRequest

public class PublicGetTokenRequest
extends Object

Token endpoint request parameters used in the "Refresh Token" flow with the `refresh_token` grant type

Field Summary

Fields

Modifier and Type	Field	Description
Long	access_token_ttl	Access token lifetime in seconds Maximum: 3600 Minimum: 600 Format: int32 Default: 3600
String	assertion	For `urn:ietf:params:oauth:grant-type:jwt-bearer` or `partner_jwt` grant types only.
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).
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).
String	client_id	The registered identifier of a client application.
String	code	For `authorization_code` grant type only.
String	code_verifier	For `authorization_code` grant type only.
String	endpoint_id	The unique identifier of a client application instance.
String	grant_type	Grant type Required Enum: authorization_code, urn:ietf:params:oauth:grant-type:jwt-bearer, partner_jwt, refresh_token
String	redirect_uri	For `authorization_code` grant type only.
String	refresh_token	For `refresh_token` grant type only.
Long	refresh_token_ttl	Refresh token lifetime in seconds Maximum: 2592000 Format: int32 Default: 604800
String	scope	The list of application permissions (OAuth scopes) requested.

Constructor Summary

Constructors

Constructor	Description
PublicGetTokenRequest()

Method Summary

Modifier and Type	Method	Description
PublicGetTokenRequest	access_token_ttl(Long access_token_ttl)
PublicGetTokenRequest	assertion(String assertion)
PublicGetTokenRequest	client_assertion(String client_assertion)
PublicGetTokenRequest	client_assertion_type(String client_assertion_type)
PublicGetTokenRequest	client_id(String client_id)
PublicGetTokenRequest	code(String code)
PublicGetTokenRequest	code_verifier(String code_verifier)
PublicGetTokenRequest	endpoint_id(String endpoint_id)
PublicGetTokenRequest	grant_type(String grant_type)
PublicGetTokenRequest	redirect_uri(String redirect_uri)
PublicGetTokenRequest	refresh_token(String refresh_token)
PublicGetTokenRequest	refresh_token_ttl(Long refresh_token_ttl)
PublicGetTokenRequest	scope(String scope)

Methods inherited from class java.lang.Object

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

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

code

public String code

For `authorization_code` grant type only. User's authorization 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

Constructor Details

PublicGetTokenRequest

public PublicGetTokenRequest()

Method Details

client_id

public PublicGetTokenRequest client_id(String client_id)

client_assertion_type

public PublicGetTokenRequest client_assertion_type(String client_assertion_type)

client_assertion

public PublicGetTokenRequest client_assertion(String client_assertion)

scope

public PublicGetTokenRequest scope(String scope)

endpoint_id

public PublicGetTokenRequest endpoint_id(String endpoint_id)

access_token_ttl

public PublicGetTokenRequest access_token_ttl(Long access_token_ttl)

refresh_token_ttl

public PublicGetTokenRequest refresh_token_ttl(Long refresh_token_ttl)

grant_type

public PublicGetTokenRequest grant_type(String grant_type)

code

public PublicGetTokenRequest code(String code)

redirect_uri

public PublicGetTokenRequest redirect_uri(String redirect_uri)

code_verifier

public PublicGetTokenRequest code_verifier(String code_verifier)

assertion

public PublicGetTokenRequest assertion(String assertion)

refresh_token

public PublicGetTokenRequest refresh_token(String refresh_token)