group.opensocial.requestJoin

{
  "lexicon": 1,
  "id": "group.opensocial.requestJoin",
  "defs": {
    "main": {
      "type": "procedure",
      "description": "Ask to join, or redeem an invite. No role required; authenticated as the requester.",
      "input": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "required": [
            "group"
          ],
          "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."
            },
            "message": {
              "type": "string"
            },
            "invite": {
              "type": "string",
              "format": "at-uri"
            }
          }
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "required": [
            "status"
          ],
          "properties": {
            "status": {
              "type": "string",
              "knownValues": [
                "admitted",
                "pending"
              ]
            }
          }
        }
      },
      "errors": [
        {
          "name": "InviteRequired"
        },
        {
          "name": "AlreadyMember"
        }
      ]
    }
  }
}