Exchange an approved device code for a device credential.

POST

/v1/auth/device-codes/{id}/token

curl --request POST \
  --url https://api.share2.us/v1/auth/device-codes/example/token \
  --header 'Content-Type: application/json' \
  --data '{ "device_code": "example" }'

• Production API
• Local API

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

device_code

required

string

Example^generated

{
  "device_code": "example"
}

Responses

200

Device credential issued.

Media typeapplication/json

object

device_token

required

string

token_type

required

string

Allowed values: device

expires_at

required

string format: date-time

Example

{
  "token_type": "device"
}

403

Device/session limit reached. Includes active CLI sessions that can be signed out.

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

request_id

required

string

sessions

required

Active CLI sessions for the approved device-code account.

Array<object>

object

id

required

string format: uuid

device_name

required

string

os

string

client_info

string

machine_id

Short display fingerprint, not the raw machine id.

string

created_at

required

string format: date-time

last_used_at

string format: date-time

expires_at

required

string format: date-time

revoked_at

string format: date-time

created_ip

string

last_ip

string

last_country

string

client_type

required

string

Allowed values: cli web

public_key

string

current

required

boolean

limit

required

Effective max_cli_sessions entitlement for the account.

integer

Example

{
  "error": {
    "code": "quota_exceeded"
  },
  "sessions": [
    {
      "client_type": "cli"
    }
  ]
}

default

Standard error envelope.

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "quota_exceeded"
  }
}