MenuMethods

Procedure · POST

group.opensocial.deleteRole

Remove a role.

Remove a role. Requires group.configure. Fails if any membership still holds it.

Requires
group.configure

Input

groupstring · didrequired

The group DID. Every method is served by the group's host and authorized against that group's roles.

rolestringrequired
≤ 64 bytes

Errors

  • RoleInUse

Schema

Lexicon JSON
{
  "lexicon": 1,
  "id": "group.opensocial.deleteRole",
  "defs": {
    "main": {
      "type": "procedure",
      "description": "Remove a role. Requires group.configure. Fails if any membership still holds it.",
      "input": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "required": [
            "group",
            "role"
          ],
          "properties": {
            "group": {
              "type": "string",
              "format": "did",
              "description": "The group DID. Every method is served by the group's host and authorized against that group's roles."
            },
            "role": {
              "type": "string",
              "maxLength": 64
            }
          }
        }
      },
      "errors": [
        {
          "name": "RoleInUse"
        }
      ]
    }
  }
}

← All methods