Package com.ringcentral.definitions

Class RopcTokenRequest

java.lang.Object

com.ringcentral.definitions.RopcTokenRequest

public class RopcTokenRequest
extends Object

Token endpoint request parameters used in the "Password" (also known as "Resource Owner Password Credentials" - ROPC) authorization flow with the `password` grant type

Field Summary

Fields

Modifier and Type	Field	Description
String	extension	For `password` grant type only.
String	grant_type	Grant type Required Enum: password
String	password	For `password` grant type only.
String	pin	IVR pin for pin-based authentication.
String	username	For `password` grant type only.

Constructor Summary

Constructors

Constructor	Description
RopcTokenRequest()

Method Summary

Modifier and Type	Method	Description
RopcTokenRequest	extension(String extension)
RopcTokenRequest	grant_type(String grant_type)
RopcTokenRequest	password(String password)
RopcTokenRequest	pin(String pin)
RopcTokenRequest	username(String username)

Methods inherited from class java.lang.Object

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

Field Details

grant_type

public String grant_type

Grant type Required Enum: password

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

Constructor Details

RopcTokenRequest

public RopcTokenRequest()

Method Details

grant_type

public RopcTokenRequest grant_type(String grant_type)

username

public RopcTokenRequest username(String username)

password

public RopcTokenRequest password(String password)

extension

public RopcTokenRequest extension(String extension)

pin

public RopcTokenRequest pin(String pin)