Package com.ringcentral.definitions

Class TokenInfo

java.lang.Object

com.ringcentral.definitions.TokenInfo

public class TokenInfo
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
String	access_token	OAuth access token to pass to subsequent API requests Required Example: U1BCMDFUMDRKV1MwMXxzLFSvXdw5PHMsVLEn_MrtcyxUsw
String	endpoint_id	Client application instance identifier that matches the value provided by the client, or generated by the server (if a client has not provided this value) Example: 8zXq6oaLT7WvwWITlGiA1A
Long	expires_in	Access token TTL (time-to-live) in seconds Required Format: int32 Example: 7199
String	id_token	OpenID Connect ID token (if OpenID Connect flow was activated during authorization)
String	owner_id	Token owner's identifier.
String	refresh_token	OAuth refresh token (if issued) Example: U1BCMDFUMDRKV1MwMXxzLFL4ec6A0XMsUv9wLriecyxS_w
Long	refresh_token_expires_in	Refresh token TTL (time-to-live) in seconds Format: int32 Example: 604799
String	scope	The list of space-separated application permissions (OAuth scopes) Required Example: AccountInfo CallLog ExtensionInfo Messages SMS
String	session_expiration_time	Absolute value of session expiration time in ISO date formatted string.
Long	session_expires_in	Remaining time in seconds until session expiration due to absolute timeout.
String	session_id	OAuth session ID Required
Long	session_idle_timeout	Nominal value of session idle timeout in seconds.
String	token_type	Type of the token.

Constructor Summary

Constructors

Constructor	Description
TokenInfo()

Method Summary

Modifier and Type	Method	Description
TokenInfo	access_token(String access_token)
TokenInfo	endpoint_id(String endpoint_id)
TokenInfo	expires_in(Long expires_in)
TokenInfo	id_token(String id_token)
TokenInfo	owner_id(String owner_id)
TokenInfo	refresh_token(String refresh_token)
TokenInfo	refresh_token_expires_in(Long refresh_token_expires_in)
TokenInfo	scope(String scope)
TokenInfo	session_expiration_time(String session_expiration_time)
TokenInfo	session_expires_in(Long session_expires_in)
TokenInfo	session_id(String session_id)
TokenInfo	session_idle_timeout(Long session_idle_timeout)
TokenInfo	token_type(String token_type)

Methods inherited from class java.lang.Object

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

Field Details

access_token

public String access_token

OAuth access token to pass to subsequent API requests Required Example: U1BCMDFUMDRKV1MwMXxzLFSvXdw5PHMsVLEn_MrtcyxUsw

expires_in

public Long expires_in

Access token TTL (time-to-live) in seconds Required Format: int32 Example: 7199

refresh_token

public String refresh_token

OAuth refresh token (if issued) Example: U1BCMDFUMDRKV1MwMXxzLFL4ec6A0XMsUv9wLriecyxS_w

refresh_token_expires_in

public Long refresh_token_expires_in

Refresh token TTL (time-to-live) in seconds Format: int32 Example: 604799

scope

public String scope

The list of space-separated application permissions (OAuth scopes) Required Example: AccountInfo CallLog ExtensionInfo Messages SMS

token_type

public String token_type

Type of the token. The only supported value is `bearer`. (This value has to be used along with the access token in the `Authorization` header of subsequent API requests) Required Example: bearer Enum: bearer

owner_id

public String owner_id

Token owner's identifier. Contains RingCentral user (extension) ID Example: 256440016

endpoint_id

public String endpoint_id

Client application instance identifier that matches the value provided by the client, or generated by the server (if a client has not provided this value) Example: 8zXq6oaLT7WvwWITlGiA1A

id_token

public String id_token

OpenID Connect ID token (if OpenID Connect flow was activated during authorization)

session_expires_in

public Long session_expires_in

Remaining time in seconds until session expiration due to absolute timeout. Returned only if absolute session timeout is enforced Format: int32

session_expiration_time

public String session_expiration_time

Absolute value of session expiration time in ISO date formatted string. Returned only if absolute session timeout is enforced Format: date-time Example: Sat Apr 01 2023 05:00:01 GMT-0700 (Pacific Daylight Time)

session_id

public String session_id

OAuth session ID Required

session_idle_timeout

public Long session_idle_timeout

Nominal value of session idle timeout in seconds. Returned only if idle session timeout is enforced Format: int32

Constructor Details

TokenInfo

public TokenInfo()

Method Details

access_token

public TokenInfo access_token(String access_token)

expires_in

public TokenInfo expires_in(Long expires_in)

refresh_token

public TokenInfo refresh_token(String refresh_token)

refresh_token_expires_in

public TokenInfo refresh_token_expires_in(Long refresh_token_expires_in)

scope

public TokenInfo scope(String scope)

token_type

public TokenInfo token_type(String token_type)

owner_id

public TokenInfo owner_id(String owner_id)

endpoint_id

public TokenInfo endpoint_id(String endpoint_id)

id_token

public TokenInfo id_token(String id_token)

session_expires_in

public TokenInfo session_expires_in(Long session_expires_in)

session_expiration_time

public TokenInfo session_expiration_time(String session_expiration_time)

session_id

public TokenInfo session_id(String session_id)

session_idle_timeout

public TokenInfo session_idle_timeout(Long session_idle_timeout)