User Management

Create a new user. Only avaialble to admin user.

post/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

Request body

namestring required

The account name to use. This will identify the account and must be globally unique in the system.

emailstring

An optional email to associate with the account for contact purposes

Example request

{
  "name": "name",
  "email": "email"
}

Response

Account Record

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

No recorded changes to this operation across all 5 revisions of this API.