Initiate device grant flow

curl --request POST \
  --url https://{sql-node}/v1/sso-device-grant \
  --header 'Content-Type: application/json' \
  --data '
{
  "database": "retail_analytics"
}
'

{
  "verification_uri_complete": "https://auth.example.com/device?code=BCDFGHJK",
  "verification_uri": "https://auth.example.com/device",
  "user_code": "BCDFGHJK",
  "status": {
    "reason": "Device authorization initiated",
    "sql_state": "00000",
    "vendor_code": 0
  }
}

SSO

Initiate device grant flow

Retrieve an OpenID device grant code that the Ocient System can verify and use with the SSO device grant verify endpoint.

The device grant process is intended for devices with limited input capabilities or no web browser:

Call this endpoint to retrieve a user code and verification URI
Display the user code and verification URI to the user
The user visits the verification URI on another device and enters the code
Call the SSO device grant verify endpoint to check if the user has completed verification

POST

sso-device-grant

Initiate device grant flow

curl --request POST \
  --url https://{sql-node}/v1/sso-device-grant \
  --header 'Content-Type: application/json' \
  --data '
{
  "database": "retail_analytics"
}
'

{
  "verification_uri_complete": "https://auth.example.com/device?code=BCDFGHJK",
  "verification_uri": "https://auth.example.com/device",
  "user_code": "BCDFGHJK",
  "status": {
    "reason": "Device authorization initiated",
    "sql_state": "00000",
    "vendor_code": 0
  }
}

Body

application/json

database

string

Target database name. Defaults to 'system' if not specified.

Response

200 - application/json

Device grant initiated

verification_uri

string<uri>

URL for user to visit to complete verification

verification_uri_complete

string<uri>

URL with user code pre-filled

user_code

string

Code for user to enter at verification URI

status

object

Status information for API responses

Show child attributes

Exchange SSO token

Verify device grant

HTTP Query API

SQL Reference

Connection Drivers

Initiate device grant flow

Body

Response