Lexicon Garden

com.getorbyt.community.listRoles

The Community's roles: the built-in owner and moderator roles, then the roles the Community defined, in order. Requires manage-roles. Viewer-specific and never cached.

Repository @getorbyt.com did:plc:2xrqztnmzlckb3xfuuukupso namespace authority
Details · query
Kindquery
Authoritycommunity.getorbyt.com
Indexed
Compare Edit in builder → Fork →
cid bafyreiceuhnhl2llxniw6g5lcq5vrxxlvngpyye6udqqxorjufl7ohbwma

Checks

Valid
  • unlimited-string defs.main.output.schema.properties.viewerActions.itemsNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "The Community's roles: the built-in owner and moderator roles, then the roles the Community defined, in order. Requires manage-roles. Viewer-specific and never cached.",
      "errors": [
        {
          "name": "AuthenticationRequired"
        },
        {
          "name": "CommunityNotFound"
        },
        {
          "name": "InsufficientRole"
        },
        {
          "name": "InvalidRequest"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "roles": {
              "items": {
                "ref": "com.getorbyt.community.defs#roleView",
                "type": "ref"
              },
              "maxLength": 32,
              "type": "array"
            },
            "viewerActions": {
              "description": "What this viewer may do to the list itself, decided by the service. Absent means nothing.",
              "items": {
                "knownValues": [
                  "createRole"
                ],
                "type": "string"
              },
              "maxLength": 8,
              "type": "array"
            }
          },
          "required": [
            "roles"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "community": {
            "format": "at-uri",
            "type": "string"
          }
        },
        "required": [
          "community"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "com.getorbyt.community.listRoles",
  "lexicon": 1
}