RingCentral .Net SDK
Properties | List of all members
RingCentral.GetTokenRequest Class Reference

Properties

string username [get, set]
 For password grant type only. User login name: email or phone number in E.164 format More...
 
string password [get, set]
 For password grant type only. User's password Format: password More...
 
string extension [get, set]
 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 More...
 
string grant_type [get, set]
 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 More...
 
string code [get, set]
 For authorization_code grant type only. User's authorization code More...
 
string redirect_uri [get, set]
 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 More...
 
long? access_token_ttl [get, set]
 Access token lifetime in seconds Maximum: 3600 Minimum: 600 Format: int32 Default: 3600 More...
 
long? refresh_token_ttl [get, set]
 Refresh token lifetime in seconds Maximum: 604800 Format: int32 Default: 604800 More...
 
string scope [get, set]
 List of application permissions to be used with access token. By default, the scope includes all permissions configured during the application registration phase More...
 
string refresh_token [get, set]
 For refresh_token grant type only. Previously issued refresh token. More...
 
string endpoint_id [get, set]
 The unique identifier of a client application instance. If not specified, the derived or auto generated value will be used More...
 
string pin [get, set]
 
string client_id [get, set]
 OAuth client identifier (if not specified via Authorization header) More...
 
string account_id [get, set]
 
string partner_account_id [get, set]
 
string client_assertion_type [get, set]
 Client assertion type More...
 
string client_assertion [get, set]
 Client assertion More...
 
string assertion [get, set]
 For jwt_bearer grant type only. Assertion More...
 
string brand_id [get, set]
 
string code_verifier [get, set]
 PKCE code verifier More...
 
string device_code [get, set]
 
string ivr_pin [get, set]
 For ivr_pin grant type only. IVR pin. More...
 

Property Documentation

◆ access_token_ttl

long? RingCentral.GetTokenRequest.access_token_ttl
getset

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

◆ account_id

string RingCentral.GetTokenRequest.account_id
getset

◆ assertion

string RingCentral.GetTokenRequest.assertion
getset

For jwt_bearer grant type only. Assertion

◆ brand_id

string RingCentral.GetTokenRequest.brand_id
getset

◆ client_assertion

string RingCentral.GetTokenRequest.client_assertion
getset

Client assertion

◆ client_assertion_type

string RingCentral.GetTokenRequest.client_assertion_type
getset

Client assertion type

◆ client_id

string RingCentral.GetTokenRequest.client_id
getset

OAuth client identifier (if not specified via Authorization header)

◆ code

string RingCentral.GetTokenRequest.code
getset

For authorization_code grant type only. User's authorization code

◆ code_verifier

string RingCentral.GetTokenRequest.code_verifier
getset

PKCE code verifier

◆ device_code

string RingCentral.GetTokenRequest.device_code
getset

◆ endpoint_id

string RingCentral.GetTokenRequest.endpoint_id
getset

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

◆ extension

string RingCentral.GetTokenRequest.extension
getset

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

string RingCentral.GetTokenRequest.grant_type
getset

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

◆ ivr_pin

string RingCentral.GetTokenRequest.ivr_pin
getset

For ivr_pin grant type only. IVR pin.

◆ partner_account_id

string RingCentral.GetTokenRequest.partner_account_id
getset

◆ password

string RingCentral.GetTokenRequest.password
getset

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

◆ pin

string RingCentral.GetTokenRequest.pin
getset

◆ redirect_uri

string RingCentral.GetTokenRequest.redirect_uri
getset

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

◆ refresh_token

string RingCentral.GetTokenRequest.refresh_token
getset

For refresh_token grant type only. Previously issued refresh token.

◆ refresh_token_ttl

long? RingCentral.GetTokenRequest.refresh_token_ttl
getset

Refresh token lifetime in seconds Maximum: 604800 Format: int32 Default: 604800

◆ scope

string RingCentral.GetTokenRequest.scope
getset

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

◆ username

string RingCentral.GetTokenRequest.username
getset

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


The documentation for this class was generated from the following file: