Auth

Start CLI device authorization

post/cli/auth/start

Request

  • Base URL: https://app.openpo.st/api/v1
  • URL: https://app.openpo.st/api/v1/cli/auth/start
  • Auth: none required

Request body

$schemastring uri

A URL to the JSON Schema for this object.

client_namestring required

CLI client name

client_osstring required

CLI host operating system

client_versionstring required

CLI client version

requested_scopesstring

Requested API token scope; omitted or cli:full

Example request

{
  "$schema": "https://example.com/api/v1/schemas/StartCLIAuthInputBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

device_codestring required
expires_ininteger required
intervalinteger required
user_codestring required
verification_urlstring required

Example response

{
  "$schema": "https://example.com/api/v1/schemas/StartCLIAuthOutputBody.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.