Lexicon Garden

town.muni.arbiter.listSpaces

Get the members that have been assigned to the space. This is not a flat membership list, but a list of the direct members of the space, including DIDs, local spaces, and remote spaces that have been added as members, without doing any resolution of remote spaces.

Repository @zicklag.dev did:plc:ulg2bzgrgs7ddjjlmhtegk3v namespace authority
Details · query
Kindquery
Authorityarbiter.muni.town
Indexed
Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

arbiterDid

requiredstring · did

The DID of the arbiter that the space is in.

resolverDepth

integer

The maximum depth to allow when doing remote resolutions. Because spaces are allowed to have members resolved from remote spaces, all of the arbiter endpoints have an optional resolution depth parameter that can be used to limit how many chained remote calls can be resolved. This applies both to queries and procedures. Queries may need to resolve external members to complete the member list, and procedures may need to resolve external members if the requesting member is not in the local member list, to see if the member has access through a remote list.

Output

application/json

spaces

requiredarray

The list of spaces on the arbiter that the requesting user has access to.

itemsobject

Errors

ErrArbiterNotExists

The specified arbiter does not exist on this server.

ErrSpaceNotExists

The specified space does not exist on this arbiter.

ErrPermissionDenied

The requesting user is not allowed to make the request.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • town.muni.arbiter.getSpaceMembers

    query

    Get the members that have been assigned to the space. This is not a flat membership list, but a list of the direct members of the space, including DIDs, local spaces, and remote spaces that have been added as members, without doing any resolution of remote spaces.

  • town.muni.arbiter.resolveSpaceMembers

    query

    Get the flattened, resolved list of members for a space. This member list will be the same as what the server is expected to return as the space host, but it will additionally contain a member config object for each member. The details of the member config object are dependent on the server implementation and possibly the arbiter config type.

  • town.muni.arbiter.getSpaceConfig

    query

    Get the configuration of a space on the arbiter.

  • town.muni.arbiter.setSpaceMemberAccess

    procedure

    Set the access of a member in a space. This is also how you add a new member to the space.

  • town.muni.arbiter.getArbiterConfig

    query

    Get the current config object for an arbiter.