3 User Management

3.1 Add User

POST https://<HOST>:<PORT>/api/users/add?version=0

Adds a new user.

Required Permissions

  • API

  • User Management Read/Write Access

Request Body Structure

The request body is structured as AddUserData JSON object. A description for its fields is at section 27.2.1. For the JSON schema refer to section 27.2.2.

Response Body Structure

The response body is structured as CustomUserOptions JSON object. A description for its fields is at section 27.3.1. For the JSON schema refer to section 27.3.2.

Example

POST http://127.0.0.1:8111/api/users/add?version=0
HTTP Request Body
{
  "ldapLogin": null,
  "loginLocally": true,
  "localPassword": "test1234",
  "roleIds": ["new_role"],
  "localUsername": "test",
  "displayName": "test",
  "enabled": true
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "emailAddress": "",
  "displayName": "test",
  "localUserName": "test",
  "roles": ["new_role"],
  "id": "c7fa28f9-c322-4247-821a-350da56327af",
  "enabled": true,
  "local": {"name": "test"}
}

3.2 Remove User

DELETE https://<HOST>:<PORT>/api/users/remove?version=0

Removes an exiting user

Required Permissions

  • API

  • User Management Read/Write Access

Request parameters

  • user

    The name or id of the user that should be removed.

Response Body Structure

The response body is structured as CustomUserOptions JSON object. A description for its fields is at section 27.3.1. For the JSON schema refer to section 27.3.2.

Example

DELETE http://127.0.0.1:8110/api/users/remove?version=0&user=test

3.3 Submit Password Change

POST https://<HOST>:<PORT>/api/users/changePassword?version=0

Sets a new password for a user.

Required Permissions

  • API

  • User Management Read/Write Access

Request parameters

  • passwordChange

    Define whether and, if so, when the password has to be changed.

    Possible values:

    • NOT_NECESSARY

    • REQUIERED

    • RECOMMENDED

  • oldPassword

    The old password of the selected user.

  • newPassword

    The new password of the selected user.

  • user

    The name of the user which password will be changed.

3.4 Get LDAP Authorities

GET https://<HOST>:<PORT>/api/users/ldapAuthorities/get?version=0

Returns the configured LDAP Authorities

Required Permissions

  • API

  • User Management Read Access

Response Body Structure

The response body is strutured as an array. The array consists of LdapAuthority JSON objects. A description for its fields is at section 27.41.1. For the JSON schema refer to section 27.41.2.

Example

GET http://127.0.0.1:8111/api/users/ldapAuthorities/get?version=0
HTTP Response
HTTP/1.1 200 OK