zone.stratos.admin.listEnrollments

{
  "id": "zone.stratos.admin.listEnrollments",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "enrollments"
          ],
          "properties": {
            "total": {
              "type": "integer",
              "description": "Total number of enrollments in the service. Absent when a boundary filter is applied."
            },
            "cursor": {
              "type": "string",
              "description": "Cursor for the next page. Absent on the last page."
            },
            "enrollments": {
              "type": "array",
              "items": {
                "ref": "#enrollment",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "properties": {
          "limit": {
            "type": "integer",
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "description": "Maximum number of enrollments to return."
          },
          "cursor": {
            "type": "string",
            "description": "Pagination cursor from a previous response."
          },
          "boundary": {
            "type": "string",
            "description": "Only return members holding this boundary."
          }
        }
      },
      "description": "List enrollments in this Stratos service. Requires admin authorization."
    },
    "enrollment": {
      "type": "object",
      "required": [
        "did",
        "enrolledAt",
        "active",
        "boundaries"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did",
          "description": "The enrolled DID."
        },
        "active": {
          "type": "boolean",
          "description": "Whether the enrollment is currently active."
        },
        "isService": {
          "type": "boolean",
          "description": "Whether this is a service enrollment rather than a user."
        },
        "boundaries": {
          "type": "array",
          "items": {
            "ref": "zone.stratos.boundary.defs#Domain",
            "type": "ref"
          }
        },
        "enrolledAt": {
          "type": "string",
          "format": "datetime",
          "description": "When the DID was enrolled."
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}