Skip to main content
POST
Start a CLI sign-in (RFC 8628 §3.1)

Body

Form-encoded (application/x-www-form-urlencoded, parsed flat) or a flat JSON object: at most 8 KB and 20 parameters, every value one string of at most 4,096 characters, a parameter sent twice refused (invalid_request).

client_id
enum<string>
required

The client starting the sign-in; another is invalid_client.

Available options:
tassyir-cli
client_version
string

Your version, shown on the approval page.

Pattern: ^[0-9A-Za-z][0-9A-Za-z.+-]{0,31}$
device_name
string

The machine's name, shown on the approval page and in the token list: letters and digits of any script, spaces and ._-'()@, at most 64 characters after trimming.

Maximum string length: 64
locale
enum<string>
default:en

The approval page's language.

Available options:
ar,
en

Response

The codes.

RFC 8628 §3.2: the device authorization response.

device_code
string
required

Poll POST /developer/cli/token with it. Never show it.

Pattern: ^tsy_dc_[0-9A-Za-z]{43}$
user_code
string
required

The code the terminal shows, XXXX-XXXX.

Pattern: ^[BCDFGHJKLMNPQRSTVWXZ]{4}-[BCDFGHJKLMNPQRSTVWXZ]{4}$
verification_uri
string<uri>
required

The approval page: <dashboard>/{locale}/developers/cli.

verification_uri_complete
string<uri>
required

The same page with ?code=XXXX-XXXX: it pre-fills the code, never approves.

expires_in
integer
required

Seconds the codes live (600).

Required range: 1 <= x <= 9007199254740991
interval
integer
required

Seconds between two polls (5).

Required range: 1 <= x <= 9007199254740991