town.muni.arbiter.defs

zicklag.dev

Documentation

didDocConfig object

Configurable fields for a DID PLC document.

Properties

alsoKnownAs array of string Required

Priority-ordered list of URIs indicating other names or aliases associated with the DID. For atproto, this should include an `at://` URI for the account's handle.

rotationKeys array of string Required

Priority-ordered list of public keys in `did:key` encoding. At least 1 and at most 5 keys, with no duplication. These keys control the DID identifier (can sign rotation operations).

services object Required

Map from service ID to service endpoint configuration. The ID should not include a `#` prefix; it will be added when rendering the DID document.

verificationMethods object Required

Map from verification method ID to public key in `did:key` encoding. The ID should not include a `#` prefix; it will be added when rendering the DID document. These keys do **not** have control over the DID.

View raw schema 
{
  "type": "object",
  "required": [
    "rotationKeys",
    "verificationMethods",
    "alsoKnownAs",
    "services"
  ],
  "properties": {
    "services": {
      "type": "object",
      "properties": {},
      "description": "Map from service ID to service endpoint configuration.\nThe ID should not include a `#` prefix; it will be added when rendering\nthe DID document."
    },
    "alsoKnownAs": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Priority-ordered list of URIs indicating other names or aliases\nassociated with the DID. For atproto, this should include an `at://`\nURI for the account's handle."
    },
    "rotationKeys": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Priority-ordered list of public keys in `did:key` encoding.\nAt least 1 and at most 5 keys, with no duplication.\nThese keys control the DID identifier (can sign rotation operations)."
    },
    "verificationMethods": {
      "type": "object",
      "properties": {},
      "description": "Map from verification method ID to public key in `did:key` encoding.\nThe ID should not include a `#` prefix; it will be added when rendering\nthe DID document. These keys do **not** have control over the DID."
    }
  },
  "description": "Configurable fields for a DID PLC document."
}
memberDid object

A member specified directly by their DID.

Properties

did string did Required

The DID of the member.

View raw schema 
{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did",
      "description": "The DID of the member."
    }
  },
  "description": "A member specified directly by their DID."
}
memberLocalSpace object

A member representing all of the members of another space that is on this arbiter.

Properties

spaceKey string Required

The key of the space on this arbiter.

maxLength: 1024 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "spaceKey"
  ],
  "properties": {
    "spaceKey": {
      "type": "string",
      "maxLength": 1024,
      "description": "The key of the space on this arbiter."
    }
  },
  "description": "A member representing all of the members of another space that is on this arbiter."
}
memberRemoteSpace object

A member representing all of the members of another space on another arbiter.

Properties

arbiterDid string did Required

The DID of the remote arbiter.

spaceKey string Required

The key of the space on the remote arbiter.

maxLength: 1024 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "arbiterDid",
    "spaceKey"
  ],
  "properties": {
    "spaceKey": {
      "type": "string",
      "maxLength": 1024,
      "description": "The key of the space on the remote arbiter."
    },
    "arbiterDid": {
      "type": "string",
      "format": "did",
      "description": "The DID of the remote arbiter."
    }
  },
  "description": "A member representing all of the members of another space on another arbiter."
}
serviceEndpoint object

A service endpoint entry within a DID document's `services` field. Maps a service ID (e.g. `atproto_pds`) to its type and URL. Per the DID PLC spec, the service ID should not include a `#` prefix; the `#` will be added when rendering the DID document.

Properties

endpoint string Required

The endpoint URL (e.g. `https://pds.example.com`).

type string Required

The type of the service (e.g. `AtprotoPersonalDataServer`).

View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "endpoint"
  ],
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of the service (e.g. `AtprotoPersonalDataServer`)."
    },
    "endpoint": {
      "type": "string",
      "description": "The endpoint URL (e.g. `https://pds.example.com`)."
    }
  },
  "description": "A service endpoint entry within a DID document's `services` field.\n\nMaps a service ID (e.g. `atproto_pds`) to its type and URL.\nPer the DID PLC spec, the service ID should not include a `#` prefix;\nthe `#` will be added when rendering the DID document."
}

Lexicon Garden

@