Start CLI sign-in

POST

/api/v1/auth/cli/start

curl --request POST \
  --url https://example.com/api/v1/auth/cli/start \
  --header 'Content-Type: application/json' \
  --data '{ "challenge": "example", "installation_name": "example", "redirect_uri": "example" }'

Starts the CLI sign-in. No session is needed to start. A signed-in User must approve the request before the CLI receives a session. It can return 429 if the request limit is reached. Route: /api/v1/auth/cli/start. Inputs: . Do not automatically replay this operation after an uncertain result.

Request Body^required

Media typeapplication/json

object

challenge

required

string

installation_name

required

string

redirect_uri

string | null

Example^generated

{
  "challenge": "example",
  "installation_name": "example",
  "redirect_uri": "example"
}

Responses

200

Media typeapplication/json

object

approval_url

required

string

device_code

required

string

expires_in

required

integer format: int64

interval

required

integer format: int64

user_code

required

string

Example^generated

{
  "approval_url": "example",
  "device_code": "example",
  "expires_in": 1,
  "interval": 1,
  "user_code": "example"
}

429

Media typeapplication/json

object

code

required

string

message

required

string

Example^generated

{
  "code": "example",
  "message": "example"
}