Skip to main content
POST
/
oauth2
/
device
/
code
Error
A valid request URL is required to generate request examples
{
  "device_code": "req_id_0987654321",
  "user_code": "BZ4K8",
  "verification_uri": "https://auth.example.com/activate",
  "interval": 5,
  "expires_in": 900,
  "obn_custom_metadata": {
    "consent_validation_method": "OAUTH2",
    "consent_message": "You will be redirected to https://auth.example.com/activate. Provide your details there to grant consent",
    "consent_status": "PENDING_VALIDATION"
  }
}

Body

application/x-www-form-urlencoded
​
client_id
string
required

The client identifier

Example:

"{{CLIENT_ID}}"

​
scope
string
required

Space-separated list of requested scopes

Example:

"openid profile email"

​
target_connection_id
string

The target connection ID for authorization

Example:

"CONN0987654321"

Response

200 - application/json

Device authorization code generated successfully

​
device_code
string
required

The device verification code

Example:

"req_id_0987654321"

​
user_code
string
required

The user verification code

Example:

"BZ4K8"

​
verification_uri
string
required

The URI where the user should enter the user_code

Example:

"https://auth.example.com/activate"

​
interval
integer
required

The polling interval in seconds

Example:

5

​
expires_in
integer
required

The expiration time in seconds

Example:

900

​
obn_custom_metadata
object
required