Skip to content

/AWS1/CL_SSISTARTDEVICEAUTHRSP

StartDeviceAuthorizationResponse

CONSTRUCTOR

IMPORTING

Optional arguments:

IV_DEVICECODE TYPE /AWS1/SSIDEVICECODE /AWS1/SSIDEVICECODE

The short-lived code that is used by the device when polling for a session token.

IV_USERCODE TYPE /AWS1/SSIUSERCODE /AWS1/SSIUSERCODE

A one-time user verification code. This is needed to authorize an in-use device.

IV_VERIFICATIONURI TYPE /AWS1/SSIURI /AWS1/SSIURI

The URI of the verification page that takes the userCode to authorize the device.

IV_VERIFICATIONURICOMPLETE TYPE /AWS1/SSIURI /AWS1/SSIURI

An alternate URL that the client can use to automatically launch a browser. This process skips the manual step in which the user visits the verification page and enters their code.

IV_EXPIRESIN TYPE /AWS1/SSIEXPIRATIONINSECONDS /AWS1/SSIEXPIRATIONINSECONDS

Indicates the number of seconds in which the verification code will become invalid.

IV_INTERVAL TYPE /AWS1/SSIINTERVALINSECONDS /AWS1/SSIINTERVALINSECONDS

Indicates the number of seconds the client must wait between attempts when polling for a session.


Queryable Attributes

deviceCode

The short-lived code that is used by the device when polling for a session token.

Accessible with the following methods

Method Description
GET_DEVICECODE() Getter for DEVICECODE, with configurable default
ASK_DEVICECODE() Getter for DEVICECODE w/ exceptions if field has no value
HAS_DEVICECODE() Determine if DEVICECODE has a value

userCode

A one-time user verification code. This is needed to authorize an in-use device.

Accessible with the following methods

Method Description
GET_USERCODE() Getter for USERCODE, with configurable default
ASK_USERCODE() Getter for USERCODE w/ exceptions if field has no value
HAS_USERCODE() Determine if USERCODE has a value

verificationUri

The URI of the verification page that takes the userCode to authorize the device.

Accessible with the following methods

Method Description
GET_VERIFICATIONURI() Getter for VERIFICATIONURI, with configurable default
ASK_VERIFICATIONURI() Getter for VERIFICATIONURI w/ exceptions if field has no val
HAS_VERIFICATIONURI() Determine if VERIFICATIONURI has a value

verificationUriComplete

An alternate URL that the client can use to automatically launch a browser. This process skips the manual step in which the user visits the verification page and enters their code.

Accessible with the following methods

Method Description
GET_VERIFICATIONURICOMPLETE() Getter for VERIFICATIONURICOMPLETE, with configurable defaul
ASK_VERIFICATIONURICOMPLETE() Getter for VERIFICATIONURICOMPLETE w/ exceptions if field ha
HAS_VERIFICATIONURICOMPLETE() Determine if VERIFICATIONURICOMPLETE has a value

expiresIn

Indicates the number of seconds in which the verification code will become invalid.

Accessible with the following methods

Method Description
GET_EXPIRESIN() Getter for EXPIRESIN

interval

Indicates the number of seconds the client must wait between attempts when polling for a session.

Accessible with the following methods

Method Description
GET_INTERVAL() Getter for INTERVAL