zone.stratos.admin.listEnrollments

lexicon.northsky.app

Documentation

List enrollments in this Stratos service. Requires admin authorization.

main query

List enrollments in this Stratos service. Requires admin authorization.

Parameters

boundary string Optional

Only return members holding this boundary.

cursor string Optional

Pagination cursor from a previous response.

limit integer Optional

Maximum number of enrollments to return.

Output

Encodingapplication/json
cursor string Optional

Cursor for the next page. Absent on the last page.

enrollments array Required

No description available.

total integer Optional

Total number of enrollments in the service. Absent when a boundary filter is applied.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Only return members holding this boundary.
Pagination cursor from a previous response.
Maximum number of enrollments to return.
View raw schema 
{
  "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"
}
enrollment object

No description available.

Properties

active boolean Required

Whether the enrollment is currently active.

did string did Required

The enrolled DID.

enrolledAt string datetime Required

When the DID was enrolled.

isService boolean Optional

Whether this is a service enrollment rather than a user.

View raw schema 
{
  "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"
}

Lexicon Garden

@