Procedure · POST

group.opensocial.updateSpace

Change a space's config, including who can read it.

Change a space's config: its name, who can read it, and which roles may act as the group in it. Requires space.configure.

Requires: space.configure

Input

groupstring · didrequired

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

spacestring · space-refrequired

namestring

readableByarray of string

credentialScopesarray of group.opensocial.access#roleScopes

Replace which roles may act as the group in this space, and for which collections. Omitted means unchanged.

Schema

Lexicon JSON

{
  "lexicon": 1,
  "id": "group.opensocial.updateSpace",
  "defs": {
    "main": {
      "type": "procedure",
      "description": "Change a space's config: its name, who can read it, and which roles may act as the group in it. Requires space.configure.",
      "input": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "required": [
            "group",
            "space"
          ],
          "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."
            },
            "space": {
              "type": "string",
              "format": "space-ref"
            },
            "name": {
              "type": "string"
            },
            "readableBy": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "credentialScopes": {
              "type": "array",
              "items": {
                "type": "ref",
                "ref": "group.opensocial.access#roleScopes"
              },
              "description": "Replace which roles may act as the group in this space, and for which collections. Omitted means unchanged."
            }
          }
        }
      }
    }
  }
}

← All methods