zone.stratos.admin.listAdmins

List everyone holding admin access. Requires admin authorization.

Details · query
Kindquery
Authorityadmin.stratos.zone
Indexed
cid bafyreicelku6aulo3xn5ku2sqyujexks3yhnysuwfgcvo3zmzir6avojb4

Checks

Valid
  • unlimited-string defs.admin.properties.sourceNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "admin": {
      "properties": {
        "addedAt": {
          "description": "When access was granted. Absent for config admins.",
          "format": "datetime",
          "type": "string"
        },
        "addedBy": {
          "description": "Who granted access. Absent for config admins.",
          "format": "did",
          "type": "string"
        },
        "did": {
          "format": "did",
          "type": "string"
        },
        "source": {
          "description": "Where the grant comes from. Config admins cannot be revoked through the API.",
          "knownValues": [
            "config",
            "database"
          ],
          "type": "string"
        }
      },
      "required": [
        "did",
        "source"
      ],
      "type": "object"
    },
    "main": {
      "description": "List everyone holding admin access. Requires admin authorization.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "admins": {
              "items": {
                "ref": "#admin",
                "type": "ref"
              },
              "type": "array"
            },
            "viewer": {
              "description": "The DID of the requesting admin.",
              "format": "did",
              "type": "string"
            }
          },
          "required": [
            "admins",
            "viewer"
          ],
          "type": "object"
        }
      },
      "type": "query"
    }
  },
  "id": "zone.stratos.admin.listAdmins",
  "lexicon": 1
}