PAparagraph-xyz
auth

Create an API auth session

Changed on

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

  • Base URL
    https://public.api.paragraph.com/api
  • URL
    https://public.api.paragraph.com/api/v1/api/auth/sessions
  • Auth
    none required

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