Lexicon Garden

zone.stratos.admin.listEnrollments

List enrollments in this Stratos service. Requires admin authorization.

Repository @lexicon.northsky.app did:plc:6uxgo3ypovauub7nblwylqyv namespace authority
Details · query
Kindquery
Authorityadmin.stratos.zone
Indexed
Compare Edit in builder → Fork →
cid bafyreiglsadnxouoya3fvz2z5n44d55n7mqkb3ffz4hou3bje74q7d2tmq

Checks

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