Federation

Federation and external identity

Post Users Me Identity Reset

Last-resort: wipe all of this user's encrypted data and clear the federation identity so they can re-run identity setup. Session + passkeys survive; everything encrypted under the old seed is gone. Irreversible.

Request Body

application/jsonRequired

confirmRequiredstring

Response Body

curl -X POST "https://example.com/users/me/identity/reset" \
  -H "Content-Type: application/json" \
  -d '{
    "confirm": "erase-all-my-data"
  }'

const body = JSON.stringify({
  "confirm": "erase-all-my-data"
})

fetch("https://example.com/users/me/identity/reset", {
  body
})

package main

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

func main() {
  url := "https://example.com/users/me/identity/reset"
  body := strings.NewReader(`{
    "confirm": "erase-all-my-data"
  }`)
  req, _ := http.NewRequest("POST", url, body)
  req.Header.Add("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

import requests

url = "https://example.com/users/me/identity/reset"
body = {
  "confirm": "erase-all-my-data"
}
response = requests.request("POST", url, json = body, headers = {
  "Content-Type": "application/json"
})

print(response.text)

Empty

Get Users Me Revocations Pending

List peer handles queued for revocation after an identity reset.

Response Body

curl -X GET "https://example.com/users/me/revocations/pending"

fetch("https://example.com/users/me/revocations/pending")

package main

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

func main() {
  url := "https://example.com/users/me/revocations/pending"

  req, _ := http.NewRequest("GET", url, nil)
  
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

import requests

url = "https://example.com/users/me/revocations/pending"

response = requests.request("GET", url)

print(response.text)

Empty

Post Users Me Revocations Flush

Deliver client-signed RELATIONSHIP_REVOKE envelopes to their peers. Rows that deliver are dropped; failures stay queued for retry.

Request Body

application/jsonRequired

itemsRequiredarray<object>

Response Body

curl -X POST "https://example.com/users/me/revocations/flush" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      {
        "peerHandle": "string",
        "signature": "string",
        "nonce": "string",
        "timestamp": "string",
        "messageVersion": 0
      }
    ]
  }'

const body = JSON.stringify({
  "items": [
    {
      "peerHandle": "string",
      "signature": "string",
      "nonce": "string",
      "timestamp": "string",
      "messageVersion": 0
    }
  ]
})

fetch("https://example.com/users/me/revocations/flush", {
  body
})

package main

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

func main() {
  url := "https://example.com/users/me/revocations/flush"
  body := strings.NewReader(`{
    "items": [
      {
        "peerHandle": "string",
        "signature": "string",
        "nonce": "string",
        "timestamp": "string",
        "messageVersion": 0
      }
    ]
  }`)
  req, _ := http.NewRequest("POST", url, body)
  req.Header.Add("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

import requests

url = "https://example.com/users/me/revocations/flush"
body = {
  "items": [
    {
      "peerHandle": "string",
      "signature": "string",
      "nonce": "string",
      "timestamp": "string",
      "messageVersion": 0
    }
  ]
}
response = requests.request("POST", url, json = body, headers = {
  "Content-Type": "application/json"
})

print(response.text)

Empty

Delete Users Me Revocations Pending By Peer Handle

Drop a queued revocation without delivering it.

Path Parameters

peerHandleRequiredstring

Response Body

curl -X DELETE "https://example.com/users/me/revocations/pending/string"

fetch("https://example.com/users/me/revocations/pending/string")

package main

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

func main() {
  url := "https://example.com/users/me/revocations/pending/string"

  req, _ := http.NewRequest("DELETE", url, nil)
  
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

import requests

url = "https://example.com/users/me/revocations/pending/string"

response = requests.request("DELETE", url)

print(response.text)

Empty

Get Users Me Identity

Get current user federation identity (handle, keys)

Response Body

curl -X GET "https://example.com/users/me/identity"

fetch("https://example.com/users/me/identity")

package main

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

func main() {
  url := "https://example.com/users/me/identity"

  req, _ := http.NewRequest("GET", url, nil)
  
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

import requests

url = "https://example.com/users/me/identity"

response = requests.request("GET", url)

print(response.text)

Empty

Patch Users Me Alias

Update current user alias (username for federation)

Request Body

application/jsonRequired

aliasRequiredstring

Response Body

curl -X PATCH "https://example.com/users/me/alias" \
  -H "Content-Type: application/json" \
  -d '{
    "alias": "string"
  }'

const body = JSON.stringify({
  "alias": "string"
})

fetch("https://example.com/users/me/alias", {
  body
})

package main

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

func main() {
  url := "https://example.com/users/me/alias"
  body := strings.NewReader(`{
    "alias": "string"
  }`)
  req, _ := http.NewRequest("PATCH", url, body)
  req.Header.Add("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

import requests

url = "https://example.com/users/me/alias"
body = {
  "alias": "string"
}
response = requests.request("PATCH", url, json = body, headers = {
  "Content-Type": "application/json"
})

print(response.text)

Empty

Put Users Me Keys

Request Body

application/jsonRequired

signingKeyRequiredstring

encryptionKeyRequiredstring

Response Body

curl -X PUT "https://example.com/users/me/keys" \
  -H "Content-Type: application/json" \
  -d '{
    "signingKey": "string",
    "encryptionKey": "string"
  }'

const body = JSON.stringify({
  "signingKey": "string",
  "encryptionKey": "string"
})

fetch("https://example.com/users/me/keys", {
  body
})

package main

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

func main() {
  url := "https://example.com/users/me/keys"
  body := strings.NewReader(`{
    "signingKey": "string",
    "encryptionKey": "string"
  }`)
  req, _ := http.NewRequest("PUT", url, body)
  req.Header.Add("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

import requests

url = "https://example.com/users/me/keys"
body = {
  "signingKey": "string",
  "encryptionKey": "string"
}
response = requests.request("PUT", url, json = body, headers = {
  "Content-Type": "application/json"
})

print(response.text)

Empty

Post Federation Inbox

Receive federation messages from other servers

Request Body

application/jsonRequired

protocol_versionnumber

message_typestring

message_versionnumber

noncestring

typestring

fromRequiredstring

toRequiredstring

timestampRequiredstring

signatureRequiredstring

payloadobject

Response Body

curl -X POST "https://example.com/federation/inbox" \
  -H "Content-Type: application/json" \
  -d '{
    "protocol_version": 0,
    "message_type": "string",
    "message_version": 0,
    "nonce": "string",
    "type": "string",
    "from": "string",
    "to": "string",
    "timestamp": "string",
    "signature": "string",
    "payload": {}
  }'

const body = JSON.stringify({
  "protocol_version": 0,
  "message_type": "string",
  "message_version": 0,
  "nonce": "string",
  "type": "string",
  "from": "string",
  "to": "string",
  "timestamp": "string",
  "signature": "string",
  "payload": {}
})

fetch("https://example.com/federation/inbox", {
  body
})

package main

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

func main() {
  url := "https://example.com/federation/inbox"
  body := strings.NewReader(`{
    "protocol_version": 0,
    "message_type": "string",
    "message_version": 0,
    "nonce": "string",
    "type": "string",
    "from": "string",
    "to": "string",
    "timestamp": "string",
    "signature": "string",
    "payload": {}
  }`)
  req, _ := http.NewRequest("POST", url, body)
  req.Header.Add("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

import requests

url = "https://example.com/federation/inbox"
body = {
  "protocol_version": 0,
  "message_type": "string",
  "message_version": 0,
  "nonce": "string",
  "type": "string",
  "from": "string",
  "to": "string",
  "timestamp": "string",
  "signature": "string",
  "payload": {}
}
response = requests.request("POST", url, json = body, headers = {
  "Content-Type": "application/json"
})

print(response.text)

Empty