CliLogin

Start a CLI sign-in

Starts a device sign-in for the CLI (ranla login). No key needed. Show the person verification_url and user_code; they sign up or sign in, check the code, pick the workspace and approve. Meanwhile poll POST /cli/login/token with device_code every interval seconds. Rate limited per client address.

post/cli/login

Request

  • Base URL: https://api.supersendtx.com
  • URL: https://api.supersendtx.com/cli/login
  • Auth: none required

Request body

workspacestring

Workspace name or id to suggest on the approval page. The person still decides.

Response

Sign-in started

device_codestring required

Secret. Poll with it; never show it.

user_codestring required

What the person checks on the approval page.

verification_urlstring uri required

The approval page, with the code filled in.

expires_ininteger required

Seconds until the sign-in expires.

intervalinteger required

Seconds to wait between polls.

Example response

{
  "user_code": "BCDF-GHJK"
}

Changes

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