# town.muni.arbiter.resolveSpaceMembers

> Published by [zicklag.dev](https://lexicon.garden/identity/did:plc:ulg2bzgrgs7ddjjlmhtegk3v)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:ulg2bzgrgs7ddjjlmhtegk3v/town.muni.arbiter.resolveSpaceMembers)
- [Documentation](https://lexicon.garden/lexicon/did:plc:ulg2bzgrgs7ddjjlmhtegk3v/town.muni.arbiter.resolveSpaceMembers/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:ulg2bzgrgs7ddjjlmhtegk3v/town.muni.arbiter.resolveSpaceMembers/examples)

## Definitions

### `town.muni.arbiter.resolveSpaceMembers`

**Type**: `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.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `spaceKey` | `string` | Yes | The key of the space to configure. |
| `arbiterDid` | `string` (did) | Yes | The DID of the arbiter that the space is in. |
| `resolverDepth` | `integer` | No | 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

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `members` | `array` | Yes | The members of the space |
| `missingSpaces` | `array` | Yes | Contains the list of remote spaces that could not be resolved.  If the hosts of remote spaces time out, then the server will reply with all of the members that it was able to resolve and will list the spaces that could not be resolved in `missingSpaces`. |

#### 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.

## Raw Schema

```json
{
  "id": "town.muni.arbiter.resolveSpaceMembers",
  "defs": {
    "main": {
      "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",
            "missingSpaces"
          ],
          "properties": {
            "members": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "did",
                  "access"
                ],
                "properties": {
                  "did": {
                    "type": "string",
                    "format": "did",
                    "description": "The member DID."
                  },
                  "access": {
                    "refs": [],
                    "type": "union",
                    "description": "The member's access config object."
                  }
                }
              },
              "description": "The members of the space"
            },
            "missingSpaces": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "space",
                  "access"
                ],
                "properties": {
                  "space": {
                    "ref": "town.muni.arbiter.defs#memberRemoteSpace",
                    "type": "ref",
                    "description": "The space that could not be resolved."
                  },
                  "access": {
                    "refs": [],
                    "type": "union",
                    "description": "The access object of the space that could not be resolved."
                  }
                }
              },
              "description": "Contains the list of remote spaces that could not be resolved.\n\nIf the hosts of remote spaces time out, then the server will reply with all\nof the members that it was able to resolve and will list the spaces that\ncould not be resolved in `missingSpaces`."
            }
          }
        },
        "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 flattened, resolved list of members for a space.\n\nThis member list will be the same as what the server is expected to return\nas the space host, but it will additionally contain a member config\nobject for each member.\n\nThe details of the member config object are dependent on the server implementation\nand possibly the arbiter config type."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```