Package com.ringcentral.definitions

Class GetTokenRequest

java.lang.Object

com.ringcentral.definitions.GetTokenRequest

public class GetTokenRequest
extends Object

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	account_id
String	assertion	For `jwt_bearer` grant type only.
String	brand_id
String	client_assertion	Client assertion
String	client_assertion_type	Client assertion type
String	client_id	OAuth client identifier (if not specified via `Authorization` header)
String	code	For `authorization_code` grant type only.
String	code_verifier	PKCE code verifier
String	device_code
String	endpoint_id	The unique identifier of a client application instance.
String	extension	For `password` grant type only.
String	grant_type	Grant type Required Enum: authorization_code, password, refresh_token, client_credentials, urn:ietf:params:oauth:grant-type:jwt-bearer, urn:ietf:params:oauth:grant-type:device_code, device_certificate, partner_jwt, guest, personal_jwt, otp, ivr_pin
String	ivr_pin	For `ivr_pin` grant type only.
String	partner_account_id
String	password	For `password` grant type only.
String	pin
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: 604800 Format: int32 Default: 604800
String	scope	List of application permissions to be used with access token.
String	username	For `password` grant type only.

Constructor Summary

Constructors

Constructor	Description
GetTokenRequest()

Method Summary

Modifier and Type	Method	Description
GetTokenRequest	access_token_ttl(Long access_token_ttl)
GetTokenRequest	account_id(String account_id)
GetTokenRequest	assertion(String assertion)
GetTokenRequest	brand_id(String brand_id)
GetTokenRequest	client_assertion(String client_assertion)
GetTokenRequest	client_assertion_type(String client_assertion_type)
GetTokenRequest	client_id(String client_id)
GetTokenRequest	code(String code)
GetTokenRequest	code_verifier(String code_verifier)
GetTokenRequest	device_code(String device_code)
GetTokenRequest	endpoint_id(String endpoint_id)
GetTokenRequest	extension(String extension)
GetTokenRequest	grant_type(String grant_type)
GetTokenRequest	ivr_pin(String ivr_pin)
GetTokenRequest	partner_account_id(String partner_account_id)
GetTokenRequest	password(String password)
GetTokenRequest	pin(String pin)
GetTokenRequest	redirect_uri(String redirect_uri)
GetTokenRequest	refresh_token(String refresh_token)
GetTokenRequest	refresh_token_ttl(Long refresh_token_ttl)
GetTokenRequest	scope(String scope)
GetTokenRequest	username(String username)

Methods inherited from class java.lang.Object

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

Field Details

username

public String username

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

password

public String password

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

extension

public String extension

For `password` grant type only. Optional. Extension short number. If 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`

grant_type

public String grant_type

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

code

public String code

For `authorization_code` grant type only. User's authorization code

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

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: 604800 Format: int32 Default: 604800

scope

public String scope

List of application permissions to be used with access token. By default, the scope includes all permissions configured during the application registration phase

refresh_token

public String refresh_token

For `refresh_token` grant type only. Previously issued refresh token.

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

pin

public String pin

client_id

public String client_id

OAuth client identifier (if not specified via `Authorization` header)

account_id

public String account_id

partner_account_id

public String partner_account_id

client_assertion_type

public String client_assertion_type

Client assertion type

client_assertion

public String client_assertion

Client assertion

assertion

public String assertion

For `jwt_bearer` grant type only. Assertion

brand_id

public String brand_id

code_verifier

public String code_verifier

PKCE code verifier

device_code

public String device_code

ivr_pin

public String ivr_pin

For `ivr_pin` grant type only. IVR pin.

Constructor Details

GetTokenRequest

public GetTokenRequest()

Method Details

username

public GetTokenRequest username(String username)

password

public GetTokenRequest password(String password)

extension

public GetTokenRequest extension(String extension)

grant_type

public GetTokenRequest grant_type(String grant_type)

code

public GetTokenRequest code(String code)

redirect_uri

public GetTokenRequest redirect_uri(String redirect_uri)

access_token_ttl

public GetTokenRequest access_token_ttl(Long access_token_ttl)

refresh_token_ttl

public GetTokenRequest refresh_token_ttl(Long refresh_token_ttl)

scope

public GetTokenRequest scope(String scope)

refresh_token

public GetTokenRequest refresh_token(String refresh_token)

endpoint_id

public GetTokenRequest endpoint_id(String endpoint_id)

pin

public GetTokenRequest pin(String pin)

client_id

public GetTokenRequest client_id(String client_id)

account_id

public GetTokenRequest account_id(String account_id)

partner_account_id

public GetTokenRequest partner_account_id(String partner_account_id)

client_assertion_type

public GetTokenRequest client_assertion_type(String client_assertion_type)

client_assertion

public GetTokenRequest client_assertion(String client_assertion)

assertion

public GetTokenRequest assertion(String assertion)

brand_id

public GetTokenRequest brand_id(String brand_id)

code_verifier

public GetTokenRequest code_verifier(String code_verifier)

device_code

public GetTokenRequest device_code(String device_code)

ivr_pin

public GetTokenRequest ivr_pin(String ivr_pin)