users

Initialize administrator account

Initialize the 'admin' user account. Access policy: public (requires the X-Setup-Token header on an uninitialized instance unless --no-setup-token is set)

post/users/admin/init

Request

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

Headers

X-Setup-Tokenstring

Setup token (required when instance is uninitialized and --no-setup-token is not set)

Request body

Passwordstring required

Password for the admin user

Usernamestring required

Username for the admin user

Example request

{
  "Password": "admin-password",
  "Username": "admin"
}

Response

Success

Idinteger required

User Identifier

Role0 | 1 | 2 required
TokenIssueAtinteger
UseCacheboolean
Usernamestring required

Example response

{
  "Id": 1,
  "ThemeSettings": {
    "color": "dark"
  },
  "TokenIssueAt": 1,
  "UseCache": true,
  "Username": "bob"
}

Changes

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