# fyi.opensocial.profile

> 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.profile)
- [Documentation](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.profile/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.profile/examples)

## Definitions

### `fyi.opensocial.profile#invite`

**Type**: `token`

Only holders of an outstanding invite may join.

Only holders of an outstanding invite may join.

### `fyi.opensocial.profile`

**Type**: `record`

The group's profile. Written by the group authority into the meta space.

**Key**: `literal:self`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `avatar` | `blob` | No |  |
| `banner` | `blob` | No |  |
| `createdAt` | `string` (datetime) | Yes |  |
| `description` | `string` | No |  |
| `displayName` | `string` | Yes |  |
| `joinPolicy` | `string` | Yes | How new members get in: anyone may join, requests are reviewed, or invite only. |
| `url` | `string` (uri) | No | The group's own site, if it keeps one. A third-party app that shows the group can link back to it. |

### `fyi.opensocial.profile#open`

**Type**: `token`

Anyone may join by calling requestJoin; admitted immediately.

Anyone may join by calling requestJoin; admitted immediately.

### `fyi.opensocial.profile#request`

**Type**: `token`

requestJoin creates a pending request that a member with the admit action reviews.

requestJoin creates a pending request that a member with the admit action reviews.

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "invite": {
      "description": "Only holders of an outstanding invite may join.",
      "type": "token"
    },
    "main": {
      "description": "The group's profile. Written by the group authority into the meta space.",
      "key": "literal:self",
      "record": {
        "properties": {
          "avatar": {
            "accept": [
              "image/png",
              "image/jpeg"
            ],
            "maxSize": 1000000,
            "type": "blob"
          },
          "banner": {
            "accept": [
              "image/png",
              "image/jpeg"
            ],
            "maxSize": 1000000,
            "type": "blob"
          },
          "createdAt": {
            "format": "datetime",
            "type": "string"
          },
          "description": {
            "maxGraphemes": 300,
            "maxLength": 3000,
            "type": "string"
          },
          "displayName": {
            "maxGraphemes": 64,
            "maxLength": 640,
            "type": "string"
          },
          "joinPolicy": {
            "description": "How new members get in: anyone may join, requests are reviewed, or invite only.",
            "knownValues": [
              "fyi.opensocial.profile#open",
              "fyi.opensocial.profile#request",
              "fyi.opensocial.profile#invite"
            ],
            "type": "string"
          },
          "url": {
            "description": "The group's own site, if it keeps one. A third-party app that shows the group can link back to it.",
            "format": "uri",
            "type": "string"
          }
        },
        "required": [
          "displayName",
          "joinPolicy",
          "createdAt"
        ],
        "type": "object"
      },
      "type": "record"
    },
    "open": {
      "description": "Anyone may join by calling requestJoin; admitted immediately.",
      "type": "token"
    },
    "request": {
      "description": "requestJoin creates a pending request that a member with the admit action reviews.",
      "type": "token"
    }
  },
  "id": "fyi.opensocial.profile",
  "lexicon": 1
}
```