Skip to content

Get the CLI sign-in approval page

GET
/api/v1/auth/cli/approve
curl --request GET \
--url 'https://example.com/api/v1/auth/cli/approve?user_code=example' \
--header 'Authorization: Bearer <token>'

Returns the CLI sign-in approval page. It uses the account scope from a browser session. If no User is signed in, it shows a sign-in prompt. It can return 401 if the session is missing or expired and 429 if the request limit is reached. Route: /api/v1/auth/cli/approve. Inputs: user_code. Safe reads can use bounded retries.

user_code
required
string
Media typetext/html
Media typeapplication/json
object
code
required
string
message
required
string
Examplegenerated
{
"code": "example",
"message": "example"
}