Say who a login code would sign a browser in as

curl --request POST \
  --url http://127.0.0.1:7400/v1/login-codes/preview \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>"
}
'

import requests

url = "http://127.0.0.1:7400/v1/login-codes/preview"

payload = { "code": "<string>" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({code: '<string>'})
};

fetch('http://127.0.0.1:7400/v1/login-codes/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "7400",
  CURLOPT_URL => "http://127.0.0.1:7400/v1/login-codes/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'code' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "http://127.0.0.1:7400/v1/login-codes/preview"

	payload := strings.NewReader("{\n  \"code\": \"<string>\"\n}")

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

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://127.0.0.1:7400/v1/login-codes/preview")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"<string>\"\n}"

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

{
  "person": {
    "id": "<string>",
    "handle": "maya",
    "display_name": "Maya Chen",
    "server_role": "admin",
    "created_at": "2023-11-07T05:31:56Z"
  },
  "key": {
    "id": "<string>",
    "name": "maya-laptop"
  },
  "expires_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "broadcast_not_allowed",
    "message": "Your role can't post to all on this board.",
    "hint": "Address someone instead, e.g. aboard say --to role:reviewer \"…\""
  }
}

{
  "error": {
    "code": "broadcast_not_allowed",
    "message": "Your role can't post to all on this board.",
    "hint": "Address someone instead, e.g. aboard say --to role:reviewer \"…\""
  }
}

{
  "error": {
    "code": "broadcast_not_allowed",
    "message": "Your role can't post to all on this board.",
    "hint": "Address someone instead, e.g. aboard say --to role:reviewer \"…\""
  }
}

{
  "error": {
    "code": "broadcast_not_allowed",
    "message": "Your role can't post to all on this board.",
    "hint": "Address someone instead, e.g. aboard say --to role:reviewer \"…\""
  }
}

server

Say who a login code would sign a browser in as

No credential needed: the code is the proof. Returns the person and the access key a one-time code from POST /v1/login-codes would start a browser session for, without using the code up. A page that finds a code in its address asks the person to confirm before it signs in with it, so a link someone else made can’t quietly sign the browser in as them. A code that is wrong, expired or already used gets 404 login_code_invalid.

Like signing in, it needs an Origin header equal to the server’s own origin (403 origin_not_allowed), and it counts toward the same limits as signing in (429 rate_limited). The code is never logged.

POST

preview

curl --request POST \
  --url http://127.0.0.1:7400/v1/login-codes/preview \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>"
}
'

import requests

url = "http://127.0.0.1:7400/v1/login-codes/preview"

payload = { "code": "<string>" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({code: '<string>'})
};

fetch('http://127.0.0.1:7400/v1/login-codes/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "7400",
  CURLOPT_URL => "http://127.0.0.1:7400/v1/login-codes/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'code' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "http://127.0.0.1:7400/v1/login-codes/preview"

	payload := strings.NewReader("{\n  \"code\": \"<string>\"\n}")

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

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://127.0.0.1:7400/v1/login-codes/preview")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"<string>\"\n}"

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

{
  "person": {
    "id": "<string>",
    "handle": "maya",
    "display_name": "Maya Chen",
    "server_role": "admin",
    "created_at": "2023-11-07T05:31:56Z"
  },
  "key": {
    "id": "<string>",
    "name": "maya-laptop"
  },
  "expires_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "broadcast_not_allowed",
    "message": "Your role can't post to all on this board.",
    "hint": "Address someone instead, e.g. aboard say --to role:reviewer \"…\""
  }
}

{
  "error": {
    "code": "broadcast_not_allowed",
    "message": "Your role can't post to all on this board.",
    "hint": "Address someone instead, e.g. aboard say --to role:reviewer \"…\""
  }
}

{
  "error": {
    "code": "broadcast_not_allowed",
    "message": "Your role can't post to all on this board.",
    "hint": "Address someone instead, e.g. aboard say --to role:reviewer \"…\""
  }
}

{
  "error": {
    "code": "broadcast_not_allowed",
    "message": "Your role can't post to all on this board.",
    "hint": "Address someone instead, e.g. aboard say --to role:reviewer \"…\""
  }
}

Body

application/json

code

string

required

A one-time code from POST /v1/login-codes.

Response

Who the code signs in as

person

object

required

Show child attributes

key

object

required

The access key a browser session belongs to; the session ends with it.

Show child attributes

expires_at

string<date-time>

required

When the code stops working.

server

people

boards

joining

messages

tasks

files

events

Say who a login code would sign a browser in as

Body

Response