Users

Create a new user account

Superadmin-only. Create a new user account with an optional password based authentication method.

post/api/v1/users

Request

Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
URL: /api/v1/users
Auth: one of:
- HTTP bearer
- HTTP basic

Request body

tenantsstring[]

groupsstring[]

firstNamestring

lastNamestring

emailstring required

passwordstring

superAdminboolean

restrictedboolean

Response

User was successfully created

idstring

usernamestring

displayNamestring

firstNamestring

lastNamestring

emailstring

superAdminboolean

restrictedboolean

Example response

{
  "firstName": "firstName",
  "lastName": "lastName",
  "tenants": [
    {
      "name": "name",
      "id": "id"
    },
    {
      "name": "name",
      "id": "id"
    }
  ],
  "displayName": "displayName",
  "auths": [
    {
      "name": "name",
      "id": "id",
      "type": "type"
    },
    {
      "name": "name",
      "id": "id",
      "type": "type"
    }
  ],
  "restricted": true,
  "groups": [
    {
      "tenantId": "tenantId",
      "id": "id"
    },
    {
      "tenantId": "tenantId",
      "id": "id"
    }
  ],
  "id": "id",
  "superAdmin": true,
  "email": "email",
  "username": "username"
}

Changes

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