Start a device sign-in

RFC 8628 device authorization (simforge login --device). Show user_code to the person, who approves it at verification_uri in a signed-in browser; then poll the token endpoint every interval seconds.

POST /api/cli/device/code

Start a device sign-in

cURL

curl --request POST \
  --url https://dev.simforge.ai/api/cli/device/code \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data client_id=simforge-cli \
  --data 'device_name=<string>' \
  --data 'client_version=<string>' \
  --data 'client_platform=<string>' \
  --data 'scope=<string>'

200

{
  "device_code": "<string>",
  "user_code": "<string>",
  "verification_uri": "<string>",
  "verification_uri_complete": "<string>",
  "expires_in": 123,
  "interval": 123
}

Body

application/x-www-form-urlencoded

client_id · enum<string> · required

Available options: simforge-cli

device_name · string

Shown on the approval page and the account's CLI sessions list.

Maximum string length: 80

client_version · string

Maximum string length: 32

client_platform · string

Maximum string length: 40

scope · string

Space-separated scopes (default maps:read): maps:read, bench:write, scenarios:read, scenarios:write, datasets:read, runs:read, runs:write, artifacts:read, usage:read, models:read, models:write, keys:admin, runtime:read, challenge:write.

Response

200

application/json

A device code to poll with and a user code to confirm.

device_code · string · required

user_code · string · required

The code the person confirms on the verification page.

verification_uri · string · required

verification_uri_complete · string · required

expires_in · integer · required

interval · integer · required

Seconds between token polls.