Skip to main content
POST
Start a sidecar login

Headers

hoop-sidecar-token
string
required

A token the sidecar made for itself: hsc_ and at least 32 random bytes

Body

application/json

The request body resource

name
string
required

The name the sidecar asks for. The approving admin may change it.

Example:

"payments-sidecar"

Response

Created

expires_in
integer

Seconds until the code expires

Example:

600

interval
integer

Seconds the sidecar waits between polls

Example:

5

user_code
string

The code the person confirms in the web app

Example:

"BCDF-GHJK"

verification_url
string

The page that approves this code

Example:

"https://use.hoop.dev/sidecars/login?code=BCDF-GHJK"