auth

Create an API auth session

Creates a new browser-based auth session for CLI or other API clients. The returned verification URL should be opened in the user's browser to complete authentication.

post/v1/api/auth/sessions

Request body

deviceNamestring

Name of the device requesting access (e.g. user@MacBook-Pro.local)

callbackUrlstring uri

HTTPS callback URL to redirect the user to after approving the session

supportsDeliveryAcknowledgementboolean

Whether the client acknowledges secure credential storage with DELETE

Response

Session created successfully

sessionIdstring required

Unique session identifier

verificationUrlstring required

URL to open in the browser to approve the session

expiresAtstring required

ISO 8601 timestamp when the session expires

Changes

Changed in 4 of the 61 revisions of this API.13

Aug 26, 202638234fc871e71See the full diff
- ○
  added the new optional request property supportsDeliveryAcknowledgement
  new-optional-request-property
May 7, 202690de04b871331See the full diff
- ●
  removed the optional property error from the response with the 500 status
  response-optional-property-removed
Mar 30, 20264a10ba4830671See the full diff
- ○
  added the new optional request property callbackUrl
  new-optional-request-property
Mar 24, 202666520a2466411See the full diff
- ○
  endpoint added
  endpoint-added

Full history