Skip to content

Create a CLI device authorization code.

POST
/v1/auth/device-codes
curl --request POST \
--url https://api.share2.us/v1/auth/device-codes \
--header 'Content-Type: application/json' \
--data '{ "device_name": "example", "source": "cli" }'
Media typeapplication/json
object
device_name
required
string
>= 1 characters <= 120 characters
source
string
Allowed values: cli portal mcp api

Device code created.

Media typeapplication/json
object
id
required
string
user_code
required
string
verification_uri
required
string format: uri
expires_at
required
string format: date-time
interval_seconds
required
integer
>= 1
Examplegenerated
{
"id": "example",
"user_code": "example",
"verification_uri": "https://example.com",
"expires_at": "2026-04-15T12:00:00Z",
"interval_seconds": 1
}

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"
}
}