User

List all users

get

Responses

default

default response

application/json

createdDatestring · date-timeOptional

emailstringOptional

idstring · uuidOptional

modifiedDatestring · date-timeOptional

passwordstringOptional

rolestring · enumOptionalPossible values:

usernamestringOptional

get/user

HTTPcURLJavaScriptPython

GET /rest/user HTTP/1.1
Accept: */*

default

default response

[
  {
    "createdDate": "2026-07-12T00:54:43.790Z",
    "email": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "modifiedDate": "2026-07-12T00:54:43.790Z",
    "password": "text",
    "role": "READ",
    "username": "text"
  }
]

Create a new user

post

Body

application/json

createdDatestring · date-timeOptional

emailstringOptional

idstring · uuidOptional

modifiedDatestring · date-timeOptional

passwordstringOptional

rolestring · enumOptionalPossible values:

usernamestringOptional

Responses

default

default response

application/json

createdDatestring · date-timeOptional

emailstringOptional

idstring · uuidOptional

modifiedDatestring · date-timeOptional

passwordstringOptional

rolestring · enumOptionalPossible values:

usernamestringOptional

post/user

HTTPcURLJavaScriptPython

POST /rest/user HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 193

{
  "createdDate": "2026-07-12T00:54:43.790Z",
  "email": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedDate": "2026-07-12T00:54:43.790Z",
  "password": "text",
  "role": "READ",
  "username": "text"
}

default

default response

{
  "createdDate": "2026-07-12T00:54:43.790Z",
  "email": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedDate": "2026-07-12T00:54:43.790Z",
  "password": "text",
  "role": "READ",
  "username": "text"
}

Get a user by user name

get

Path parameters

userNamestringRequired

The username to look for

Responses

200

successful operation

No content

404

not found

get/user/name/{userName}

HTTPcURLJavaScriptPython

GET /rest/user/name/{userName} HTTP/1.1
Accept: */*

No content

Get password policy

get

Responses

default

default response

application/json

digitRequiredbooleanOptional

lowercaseRequiredbooleanOptional

maximumLengthinteger · int32Optional

minimumLengthinteger · int32Optional

nonAlphanumericRequiredbooleanOptional

repetitiveCharactersDisallowedbooleanOptional

uppercaseRequiredbooleanOptional

usernamestringOptional

usernameDisallowedbooleanOptional

get/user/passwordPolicy

HTTPcURLJavaScriptPython

GET /rest/user/passwordPolicy HTTP/1.1
Accept: */*

default

default response

{
  "digitRequired": true,
  "lowercaseRequired": true,
  "maximumLength": 1,
  "minimumLength": 1,
  "nonAlphanumericRequired": true,
  "repetitiveCharactersDisallowed": true,
  "uppercaseRequired": true,
  "username": "text",
  "usernameDisallowed": true
}

Get password policy per token

get

Query parameters

tokenstringOptional

Responses

default

default response

application/json

digitRequiredbooleanOptional

lowercaseRequiredbooleanOptional

maximumLengthinteger · int32Optional

minimumLengthinteger · int32Optional

nonAlphanumericRequiredbooleanOptional

repetitiveCharactersDisallowedbooleanOptional

uppercaseRequiredbooleanOptional

usernamestringOptional

usernameDisallowedbooleanOptional

get/user/passwordReset/passwordPolicy

HTTPcURLJavaScriptPython

GET /rest/user/passwordReset/passwordPolicy HTTP/1.1
Accept: */*

default

default response

{
  "digitRequired": true,
  "lowercaseRequired": true,
  "maximumLength": 1,
  "minimumLength": 1,
  "nonAlphanumericRequired": true,
  "repetitiveCharactersDisallowed": true,
  "uppercaseRequired": true,
  "username": "text",
  "usernameDisallowed": true
}

Request an email for a user to reset his password

post

Body

application/x-www-form-urlencoded

emailstringOptional

The email of the target user

Responses

202

successful operation

No content

post/user/passwordReset/request

HTTPcURLJavaScriptPython

POST /rest/user/passwordReset/request HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 16

"email='text'"

202

successful operation

No content

Get a user by ID

get

Path parameters

userIdstring · uuidRequired

The ID of the target user

Responses

200

successful operation

No content

404

not found

get/user/{userId}

HTTPcURLJavaScriptPython

GET /rest/user/{userId} HTTP/1.1
Accept: */*

No content

Delete a user

delete

Path parameters

userIdstring · uuidRequired

The ID of the target user

Responses

204

successful operation

No content

delete/user/{userId}

HTTPcURLJavaScriptPython

DELETE /rest/user/{userId} HTTP/1.1
Accept: */*

204

successful operation

No content

Change the role of a user

put

Path parameters

userIdstring · uuidRequired

The ID of the target user

Query parameters

rolestring · enumOptional

The new role for the target user

Possible values:

Responses

default

default response

application/json

createdDatestring · date-timeOptional

emailstringOptional

idstring · uuidOptional

modifiedDatestring · date-timeOptional

passwordstringOptional

rolestring · enumOptionalPossible values:

usernamestringOptional

put/user/{userId}/role

HTTPcURLJavaScriptPython

PUT /rest/user/{userId}/role HTTP/1.1
Accept: */*

default

default response

{
  "createdDate": "2026-07-12T00:54:43.790Z",
  "email": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedDate": "2026-07-12T00:54:43.790Z",
  "password": "text",
  "role": "READ",
  "username": "text"
}