# social.colibri.member

> Published by [colibri.social](https://lexicon.garden/identity/did:plc:mprdjqjluoswa7awzggaggj3)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.member)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.member/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.member/examples)

## Definitions

### `social.colibri.member`

**Type**: `record`

A community-side member record granting a user roles within the community. Lives on the community repo and is written when an admission is finalized.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `$type` | `string` (nsid) | No | The type of the record. |
| `roles` | `array` | No | Role record-keys assigned to this member on the same community repo. |
| `subject` | `string` (did) | Yes | DID of the admitted user. |
| `joinedAt` | `string` (datetime) | Yes |  |
| `nickname` | `string` | No | Optional per-community display-name override for this member. |
| `fromMembership` | `string` (at-uri) | No | Optional AT-URI of the user's `social.colibri.membership` declaration this admission was based on. |

## Raw Schema

```json
{
  "id": "social.colibri.member",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "subject",
          "joinedAt"
        ],
        "properties": {
          "$type": {
            "type": "string",
            "format": "nsid",
            "description": "The type of the record."
          },
          "roles": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "record-key"
            },
            "description": "Role record-keys assigned to this member on the same community repo."
          },
          "subject": {
            "type": "string",
            "format": "did",
            "description": "DID of the admitted user."
          },
          "joinedAt": {
            "type": "string",
            "format": "datetime"
          },
          "nickname": {
            "type": "string",
            "maxLength": 32,
            "description": "Optional per-community display-name override for this member."
          },
          "fromMembership": {
            "type": "string",
            "format": "at-uri",
            "description": "Optional AT-URI of the user's `social.colibri.membership` declaration this admission was based on."
          }
        }
      },
      "description": "A community-side member record granting a user roles within the community. Lives on the community repo and is written when an admission is finalized."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "revision": 1
}
```
