Procedure · POST

group.opensocial.createSpace

Add a modality space to the group.

Add a modality space to the group. Requires space.create.

Requires: space.create

Input

groupstring · didrequired

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

typestring · nsidrequired

skeystring · record-key

namestring

readableByarray of stringrequired

credentialScopesarray of group.opensocial.access#roleScopes

Which collections each role may write as the group DID in this space. Copied into the space's access record.

Output

uristring · space-refrequired

Schema

Lexicon JSON

{
  "lexicon": 1,
  "id": "group.opensocial.createSpace",
  "defs": {
    "main": {
      "type": "procedure",
      "description": "Add a modality space to the group. Requires space.create.",
      "input": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "required": [
            "group",
            "type",
            "readableBy"
          ],
          "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."
            },
            "type": {
              "type": "string",
              "format": "nsid"
            },
            "skey": {
              "type": "string",
              "format": "record-key"
            },
            "name": {
              "type": "string"
            },
            "readableBy": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "credentialScopes": {
              "type": "array",
              "items": {
                "type": "ref",
                "ref": "group.opensocial.access#roleScopes"
              },
              "description": "Which collections each role may write as the group DID in this space. Copied into the space's access record."
            }
          }
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "required": [
            "uri"
          ],
          "properties": {
            "uri": {
              "type": "string",
              "format": "space-ref"
            }
          }
        }
      }
    }
  }
}

← All methods