User Management

List user summaries. Only available to the system admin user.

Changed on
get/accounts

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /accounts
  • Auth: none declared

Query parameters

state'enabled' | 'disabled' | 'deleting'

Filter accounts by state

Response

Accound summary listing

namestring required

The account identifier, not updatable after creation

type'user' | 'admin' | 'service'

The user type (admin vs user). If not specified in a POST request, 'user' is default

state'enabled' | 'disabled' | 'deleting'

State of the account. Disabled accounts prevent member users from logging in, deleting accounts are disabled and pending deletion and will be removed once all owned resources are garbage collected by the system

emailstring

Optional email address associated with the account

created_atstring date-time

The timestamp when the account was created

last_updatedstring date-time

The timestamp of the last update to the account metadata itself (not users or creds)

Example response

[
  {
    "last_updated": "2000-01-23T04:56:07.000+00:00",
    "name": "name",
    "created_at": "2000-01-23T04:56:07.000+00:00",
    "state": "enabled",
    "type": "user",
    "email": "email"
  }
]

Changes

  • 38e5705e0b21Revision changes
    • breaking

      removed the enum value active from the query request parameter state

    • info

      added the new enum value enabled to the query request parameter state

  • 75f483ab10a0Revision changes
    • breaking

      removed the enum value enabled from the query request parameter state

    • info

      added the new enum value active to the query request parameter state