# farm.lore.banished

> Published by [lore.farm](https://lexicon.garden/identity/did:plc:pfyyashnoatlhgwwfq7ut64l)

✓ This is the authoritative definition for this NSID.

## Description

A user banned from a world.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:pfyyashnoatlhgwwfq7ut64l/farm.lore.banished)
- [Documentation](https://lexicon.garden/lexicon/did:plc:pfyyashnoatlhgwwfq7ut64l/farm.lore.banished/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:pfyyashnoatlhgwwfq7ut64l/farm.lore.banished/examples)

## Definitions

### `farm.lore.banished`

**Type**: `record`

Bans a user from participating in a world. Only the world owner may create banishment records.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `world` | `string` | Yes | The world domain the user is being banished from. |
| `reason` | `string` | No | Optional reason for the banishment. |
| `subject` | `string` (did) | Yes | The DID of the user being banished. |
| `createdAt` | `string` (datetime) | Yes | Timestamp of the banishment. |

## Examples

The following examples demonstrate valid data for this lexicon. [View all examples](https://lexicon.garden/lexicon/did:plc:pfyyashnoatlhgwwfq7ut64l/farm.lore.banished/examples)

### Example 1 (`#main`)

**Description**: Banning a user from a world.

```json
{
  "$type": "farm.lore.banished",
  "world": "reverie.house",
  "reason": "Repeated violations of world guidelines.",
  "subject": "did:plc:example1234567890abcde",
  "createdAt": "2026-03-23T12:00:00.000Z"
}
```

## Raw Schema

```json
{
  "id": "farm.lore.banished",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "world",
          "subject",
          "createdAt"
        ],
        "properties": {
          "world": {
            "type": "string",
            "maxLength": 253,
            "description": "The world domain the user is being banished from."
          },
          "reason": {
            "type": "string",
            "maxLength": 1024,
            "description": "Optional reason for the banishment."
          },
          "subject": {
            "type": "string",
            "format": "did",
            "description": "The DID of the user being banished."
          },
          "createdAt": {
            "type": "string",
            "format": "datetime",
            "description": "Timestamp of the banishment."
          }
        }
      },
      "description": "Bans a user from participating in a world. Only the world owner may create banishment records."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "description": "A user banned from a world."
}
```
