UserAccount

Create user account

Changed on

Creates user account from application/x-www-form-urlencoded fields matching UserMod.

post/admin-api/v1/useraccount

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/admin-api/v1/useraccount
  • Auth: oauth (defined in the document in a form this page cannot read)

Query parameters

institutionIdinteger

The institution identifier of the request. Default is the institution identifier of the institution of the current user

Response

Created user account.

uuidstring required

User UUID.

institutionIdinteger required

Institution identifier the user belongs to.

creationDatestring date-time

Creation timestamp.

namestring required

First name of the user.

surnamestring required

Surname of the user.

usernamestring required

Login username.

emailstring email

User email address.

activeboolean required

Whether the user account is active.

directLoginboolean

Whether direct login is enabled for this account.

localAccountboolean

Whether this is a local SEB Server account.

languagestring required

User locale.

timezonestring required

User time zone.

userRolesstring[] required

Example response

{
  "uuid": "f91f9c0a-15a1-4c65-89c2-2b60310f2c12",
  "institutionId": 1,
  "name": "Ada",
  "surname": "Lovelace",
  "username": "ada.lovelace",
  "email": "ada@example.org",
  "active": true,
  "directLogin": true,
  "localAccount": true,
  "language": "en",
  "timezone": "Europe/Zurich",
  "entityPrivileges": [
    {
      "id": 42,
      "entityType": "EXAM",
      "entityId": 120,
      "userUuid": "f91f9c0a-15a1-4c65-89c2-2b60310f2c12",
      "privilegeType": "READ"
    }
  ]
}

Changes

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • breaking

      the request property format changed from no format to email

    • warning

      removed the request property

    • warning

      removed the request property