# fyi.opensocial.role

> Published by [lexicons.opensocial.fyi](https://lexicon.garden/identity/did:plc:2gqnilpksz2e7faj3bwvo6qc)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.role)
- [Documentation](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.role/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.role/examples)

## Definitions

### `fyi.opensocial.role`

**Type**: `record`

Declares that a role exists. The record key is the role id.

**Key**: `any`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `bot` | `boolean` | No | People with this role are bots: accounts that act on their own, not a person. A member is a bot if any of their roles says so. |
| `createdAt` | `string` (datetime) | Yes |  |
| `description` | `string` | No |  |
| `name` | `string` | Yes |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Declares that a role exists. The record key is the role id.",
      "key": "any",
      "record": {
        "properties": {
          "bot": {
            "description": "People with this role are bots: accounts that act on their own, not a person. A member is a bot if any of their roles says so.",
            "type": "boolean"
          },
          "createdAt": {
            "format": "datetime",
            "type": "string"
          },
          "description": {
            "maxGraphemes": 300,
            "maxLength": 3000,
            "type": "string"
          },
          "name": {
            "maxGraphemes": 64,
            "maxLength": 640,
            "type": "string"
          }
        },
        "required": [
          "name",
          "createdAt"
        ],
        "type": "object"
      },
      "type": "record"
    }
  },
  "id": "fyi.opensocial.role",
  "lexicon": 1
}
```