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.
Parameters
arbiterDid
string
did
Required
The DID of the arbiter that the space is in.
resolverDepth
integer
Optional
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.
spaceKey
string
Required
The key of the space to configure.
Output
application/jsonmembers
array
Required
The members of the space
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. Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"type": "query",
"errors": [
{
"name": "ErrArbiterNotExists",
"description": "The specified arbiter does not exist on this server."
},
{
"name": "ErrSpaceNotExists",
"description": "The specified space does not exist on this arbiter."
},
{
"name": "ErrPermissionDenied",
"description": "The requesting user is not allowed to make the request."
}
],
"output": {
"schema": {
"type": "object",
"required": [
"members"
],
"properties": {
"members": {
"type": "array",
"items": {
"type": "object",
"required": [
"member",
"access"
],
"properties": {
"access": {
"refs": [],
"type": "union",
"description": "The member's access config object."
},
"member": {
"refs": [
"town.muni.arbiter.defs#memberDid",
"town.muni.arbiter.defs#memberLocalSpace",
"town.muni.arbiter.defs#memberRemoteSpace"
],
"type": "union",
"description": "The member ID"
}
}
},
"description": "The members of the space"
}
}
},
"encoding": "application/json"
},
"parameters": {
"type": "params",
"required": [
"arbiterDid",
"spaceKey"
],
"properties": {
"spaceKey": {
"type": "string",
"maxLength": 1024,
"description": "The key of the space to configure."
},
"arbiterDid": {
"type": "string",
"format": "did",
"description": "The DID of the arbiter that the space is in."
},
"resolverDepth": {
"type": "integer",
"description": "The maximum depth to allow when doing remote resolutions.\n\nBecause spaces are allowed to have members resolved from remote spaces,\nall of the arbiter endpoints have an optional resolution depth parameter\nthat can be used to limit how many chained remote calls can be resolved.\n\nThis applies both to queries and procedures. Queries may need to resolve\nexternal members to complete the member list, and procedures may need\nto resolve external members if the requesting member is not in the local\nmember list, to see if the member has access through a remote list."
}
}
},
"description": "Get the members that have been assigned to the space.\n\nThis is not a flat membership list, but a list of the direct members\nof the space, including DIDs, local spaces, and remote spaces that have\nbeen added as members, without doing any resolution of remote spaces."
}