zone.stratos.admin.listEnrollments

List enrollments in this Stratos service. Requires admin authorization.

Details · query
Kindquery
Authorityadmin.stratos.zone
Indexed

Query

query · GET

Parameters

query string

boundary

string

Only return members holding this boundary.

cursor

string

Pagination cursor from a previous response.

limit

integer

Maximum number of enrollments to return.

  • minimum: 1
  • maximum: 100
  • default: 50

Output

application/json

cursor

string

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

enrollments

requiredarray
itemsref
Reference

total

integer

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

#enrollment

object

Properties

active

requiredboolean

Whether the enrollment is currently active.

boundaries

requiredarray

did

requiredstring · did

The enrolled DID.

enrolledAt

requiredstring · datetime

When the DID was enrolled.

isService

boolean

Whether this is a service enrollment rather than a user.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.