Lexicon Garden

pub.chive.admin.assignRole

Assign a role to a user

Repository @lexicons.governance.chive.pub did:plc:egjghlwgts2hlcer2txilxeh not from the namespace authority
Details · procedure
Kindprocedure
Authorityadmin.chive.pub
Indexed
Compare Edit in builder → Fork →
cid bafyreiafpbtv4tyax5e3d7jqghpwrgje2jicpxahzy4lynzcyw3kntcmqq

Checks

Valid
  • unlimited-string defs.main.input.schema.properties.roleNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Assign a role to a user",
      "errors": [
        {
          "name": "AuthenticationRequired"
        },
        {
          "name": "AdminRequired"
        },
        {
          "name": "InvalidRequest"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "did": {
              "description": "Target user DID",
              "format": "did",
              "type": "string"
            },
            "role": {
              "description": "Role to assign",
              "knownValues": [
                "admin",
                "moderator",
                "graph-editor",
                "author",
                "reader",
                "alpha-tester",
                "premium"
              ],
              "type": "string"
            }
          },
          "required": [
            "did",
            "role"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "success": {
              "description": "Whether the role was assigned",
              "type": "boolean"
            }
          },
          "required": [
            "success"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "pub.chive.admin.assignRole",
  "lexicon": 1,
  "revision": 1
}