Initiate the device-code flow

Mint a pending device-code pair. Unauthenticated — the device_code returned in the body is itself the credential the CLI uses to poll. The user_code is the human-facing 8-char approval code (formatted XXXX-XXXX) the operator enters on the verification page.

Initiate the device-code flow

cURL

curl --request POST \
  --url https://breadbox.example.com/api/v1/auth/device-code

import requests

url = "https://breadbox.example.com/api/v1/auth/device-code"

response = requests.post(url)

print(response.text)

const options = {method: 'POST'};

fetch('https://breadbox.example.com/api/v1/auth/device-code', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://breadbox.example.com/api/v1/auth/device-code",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://breadbox.example.com/api/v1/auth/device-code"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://breadbox.example.com/api/v1/auth/device-code")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://breadbox.example.com/api/v1/auth/device-code")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

201

{
  "device_code": "<string>",
  "user_code": "<string>",
  "verification_url": "<string>",
  "expires_in": 123,
  "interval": 123
}

Response

201 - application/json

Pending device-code created.

device_code · string · required

Opaque polling credential carried by the CLI

user_code · string · required

8-char human-facing code formatted XXXX-XXXX

verification_url · string · required

URL the operator opens to approve

expires_in · integer · required

TTL in seconds (10 minutes by default)

interval · integer · required

Suggested polling cadence in seconds