MenuMethods

Procedure · POST

group.opensocial.ejectMember

Remove a member and their access.

Remove a member and their access. Requires eject; every role the member holds must be in the caller's assignable set.

Requires
eject

Input

groupstring · didrequired

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

memberstring · didrequired
reasonstring

Errors

  • NotAssignable

Schema

Lexicon JSON
{
  "lexicon": 1,
  "id": "group.opensocial.ejectMember",
  "defs": {
    "main": {
      "type": "procedure",
      "description": "Remove a member and their access. Requires eject; every role the member holds must be in the caller's assignable set.",
      "input": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "required": [
            "group",
            "member"
          ],
          "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."
            },
            "member": {
              "type": "string",
              "format": "did"
            },
            "reason": {
              "type": "string"
            }
          }
        }
      },
      "errors": [
        {
          "name": "NotAssignable"
        }
      ]
    }
  }
}

← All methods