rip.pds.admin.defs

pds.rip

Documentation

accountView object

An account as an operator sees it, which is an accountView plus who holds it.

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

deletedAt string datetime Optional

An RFC 3339 formatted timestamp.

did string did Required

A decentralized identifier (DID).

didMethod string Required

No description available.

Known values: plc, web

expiresAt string datetime Optional

Absent when the account never expires.

extensions integer Optional

No description available.

handle string handle Required

An AT Protocol handle (e.g., alice.bsky.social).

handleDomain string Optional

No description available.

origin string Required

Whether this server minted the identity or it arrived by migration.

Known values: minted, imported

ownerDid string did Optional

Who asked for this account. Absent for anything created before the invite gate.

protected boolean Optional

No description available.

retiredAt string datetime Optional

When the identity was tombstoned or unpublished.

status string Optional

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "did",
    "handle",
    "didMethod",
    "origin",
    "createdAt"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "handle": {
      "type": "string",
      "format": "handle"
    },
    "origin": {
      "type": "string",
      "description": "Whether this server minted the identity or it arrived by migration.",
      "knownValues": [
        "minted",
        "imported"
      ]
    },
    "status": {
      "type": "string"
    },
    "ownerDid": {
      "type": "string",
      "format": "did",
      "description": "Who asked for this account. Absent for anything created before the invite gate."
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "deletedAt": {
      "type": "string",
      "format": "datetime"
    },
    "didMethod": {
      "type": "string",
      "knownValues": [
        "plc",
        "web"
      ]
    },
    "expiresAt": {
      "type": "string",
      "format": "datetime",
      "description": "Absent when the account never expires."
    },
    "protected": {
      "type": "boolean"
    },
    "retiredAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the identity was tombstoned or unpublished."
    },
    "extensions": {
      "type": "integer"
    },
    "handleDomain": {
      "type": "string"
    }
  },
  "description": "An account as an operator sees it, which is an accountView plus who holds it."
}

eventView object

One recorded lifecycle fact.

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

detail string Optional

The event's payload as JSON, for anything the fields above do not carry.

did string did Optional

A decentralized identifier (DID).

handle string Optional

The handle that DID held, when it is still known.

id integer Required

No description available.

source string Required

What observed it.

Known values: proxy, firehose, scheduler, admin, labeler

type string Required

No description available.

Known values: account.created, account.deleted, account.takedown, account.restored, account.labeled, handle.changed, identity.retired

View raw schema

{
  "type": "object",
  "required": [
    "id",
    "type",
    "source",
    "createdAt"
  ],
  "properties": {
    "id": {
      "type": "integer"
    },
    "did": {
      "type": "string",
      "format": "did"
    },
    "type": {
      "type": "string",
      "knownValues": [
        "account.created",
        "account.deleted",
        "account.takedown",
        "account.restored",
        "account.labeled",
        "handle.changed",
        "identity.retired"
      ]
    },
    "detail": {
      "type": "string",
      "description": "The event's payload as JSON, for anything the fields above do not carry."
    },
    "handle": {
      "type": "string",
      "description": "The handle that DID held, when it is still known."
    },
    "source": {
      "type": "string",
      "description": "What observed it.",
      "knownValues": [
        "proxy",
        "firehose",
        "scheduler",
        "admin",
        "labeler"
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    }
  },
  "description": "One recorded lifecycle fact."
}

limitsView object

An operator's exception to the configured limits for one person.

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

lifetimeDaysOverride integer Optional

Maximum lifetime in days. Absent means the configured default.

note string Optional

Why, in the operator's own words.

maxLength: 500 bytes

quotaOverride integer Optional

Live accounts they may hold. Absent means the configured default.

updatedAt string datetime Required

An RFC 3339 formatted timestamp.

updatedBy string did Optional

A decentralized identifier (DID).

View raw schema

{
  "type": "object",
  "required": [
    "createdAt",
    "updatedAt"
  ],
  "properties": {
    "note": {
      "type": "string",
      "maxLength": 500,
      "description": "Why, in the operator's own words."
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "updatedAt": {
      "type": "string",
      "format": "datetime"
    },
    "updatedBy": {
      "type": "string",
      "format": "did"
    },
    "quotaOverride": {
      "type": "integer",
      "description": "Live accounts they may hold. Absent means the configured default."
    },
    "lifetimeDaysOverride": {
      "type": "integer",
      "description": "Maximum lifetime in days. Absent means the configured default."
    }
  },
  "description": "An operator's exception to the configured limits for one person."
}

ownerView object

Someone who holds or has held accounts on this server, as an operator sees them.

Properties

deleted integer Required

Accounts of theirs that are gone, however they went.

did string did Required

A decentralized identifier (DID).

firstSeenAt string datetime Optional

Earliest of their first account and their first authenticated request. Absent when neither is known.

handle string handle Optional

The holder's own handle, resolved from their DID document. Not a handle they minted here. Absent when their identity could not be resolved, in which case the DID is the name.

lastCreatedAt string datetime Optional

When they last created an account. Absent when they hold none and never have.

lastSeenAt string datetime Optional

Their last authenticated request. Absent for anyone last seen before this was recorded.

limits ref #limitsView Optional

The override itself. Absent when the configured defaults apply untouched, which is the common case: a record exists for everyone who has used this server, not only for exceptions.

live integer Required

Accounts they hold right now.

maxLifetimeDays integer Required

How far an account of theirs may be extended, after any override.

quota integer Required

Live accounts they may hold at once, after any override. Zero means they may create nothing further.

takenDown integer Required

Accounts of theirs the PDS currently considers taken down.

View raw schema

{
  "type": "object",
  "required": [
    "did",
    "live",
    "deleted",
    "takenDown",
    "quota",
    "maxLifetimeDays"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "live": {
      "type": "integer",
      "description": "Accounts they hold right now."
    },
    "quota": {
      "type": "integer",
      "description": "Live accounts they may hold at once, after any override. Zero means they may create nothing further."
    },
    "handle": {
      "type": "string",
      "format": "handle",
      "description": "The holder's own handle, resolved from their DID document. Not a handle they minted here. Absent when their identity could not be resolved, in which case the DID is the name."
    },
    "limits": {
      "ref": "#limitsView",
      "type": "ref",
      "description": "The override itself. Absent when the configured defaults apply untouched, which is the common case: a record exists for everyone who has used this server, not only for exceptions."
    },
    "deleted": {
      "type": "integer",
      "description": "Accounts of theirs that are gone, however they went."
    },
    "takenDown": {
      "type": "integer",
      "description": "Accounts of theirs the PDS currently considers taken down."
    },
    "lastSeenAt": {
      "type": "string",
      "format": "datetime",
      "description": "Their last authenticated request. Absent for anyone last seen before this was recorded."
    },
    "firstSeenAt": {
      "type": "string",
      "format": "datetime",
      "description": "Earliest of their first account and their first authenticated request. Absent when neither is known."
    },
    "lastCreatedAt": {
      "type": "string",
      "format": "datetime",
      "description": "When they last created an account. Absent when they hold none and never have."
    },
    "maxLifetimeDays": {
      "type": "integer",
      "description": "How far an account of theirs may be extended, after any override."
    }
  },
  "description": "Someone who holds or has held accounts on this server, as an operator sees them."
}