User Admin

GET

Retrieves all user roles.

GET/users/user-roles

Response

200

User roles retrieved successfully

Body

application/json

idnumber

Example: 1

namestring

Example: "Admin"

Request

JavaScriptCurlPython

const response = await fetch('/users/user-roles', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": 1,
    "name": "Admin"
  }
]

Searches for users based on the provided search term.

GET/users/search

Response

200400

Users retrieved successfully

Body

application/json

idnumber

Example: 1

emailstring

Example: "[e-mail]"

firstNamestring

Example: "John"

lastNamestring

Example: "Doe"

statusstring

Example: "active"

rolesarray of object

Request

JavaScriptCurlPython

const response = await fetch('/users/search', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "id": 1,
    "email": "[e-mail]",
    "firstName": "John",
    "lastName": "Doe",
    "status": "active",
    "roles": [
      {
        "id": 1,
        "name": "Admin"
      }
    ]
  }
]

Retrieves a user by their ID.

GET/users/{id}

Path parameters

id*string

Response

200400404

User retrieved successfully

Body

application/json

idnumber

Example: 1

emailstring

Example: "[e-mail]"

firstNamestring

Example: "John"

lastNamestring

Example: "Doe"

statusstring

Example: "active"

rolesarray of object

Request

JavaScriptCurlPython

const response = await fetch('/users/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

{
  "id": 1,
  "email": "[e-mail]",
  "firstName": "John",
  "lastName": "Doe",
  "status": "active",
  "roles": [
    {
      "id": 1,
      "name": "Admin"
    }
  ]
}

Retrieves a photo by its file name.

GET/users/get-photo/{fileName}

Path parameters

fileName*string

Response

200404

Photo retrieved successfully

Body

application/json

string (binary)

Request

JavaScriptCurlPython

const response = await fetch('/users/get-photo/{fileName}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

binary

POST

Retrieves all users based on the provided search parameters.

POST/users

Body

application/json

isDeleted*boolean

Indicates if deleted users should be included

Example: false

globalSearch*nullable string

Global search term

Example: "search term"

status*nullable array of enum

Status of the accounts

roles*nullable array of enum

Roles of the users

sortField*nullable string

Field to sort by

Example: "createdAt"

sortOrder*nullable enum

Order to sort by

Example: "ASC"

ASCDESC

Response

200400

Users retrieved successfully

Body

application/json

countnumber

Example: 10

usersarray of object

Request

JavaScriptCurlPython

const response = await fetch('/users', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "isDeleted": false,
      "globalSearch": "search term",
      "status": [
        "Active"
      ],
      "roles": [
        "Admin",
        "User"
      ],
      "sortField": "createdAt",
      "sortOrder": "ASC"
    }),
});
const data = await response.json();

Response

200400

{
  "count": 10,
  "users": [
    {
      "id": 1,
      "email": "[e-mail]",
      "firstName": "John",
      "lastName": "Doe",
      "status": "active",
      "roles": [
        {
          "id": 1,
          "name": "Admin"
        }
      ]
    }
  ]
}

Uploads a photo for the authenticated user.

POST/users/upload-photo

Body

application/json

Photo upload data

photostring (binary)

Response

200400

Photo uploaded successfully

Body

application/json

string

Example: "formatted_file_name.jpg"

Request

JavaScriptCurlPython

const response = await fetch('/users/upload-photo', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

formatted_file_name.jpg

PATCH

Archives multiple users.

PATCH/users/archive

Body

application/json

User archiving data

ids*array of number

Array of IDs

Response

200400403500

Users archived successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/users/archive', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ids": [
        1,
        2,
        3
      ]
    }),
});
const data = await response.json();

Response

200400403500

{
  "message": "Users archived successfully",
  "description": "<p>The users have been archived successfully.</p>",
  "__$markdownParsed": true
}

Restores multiple archived users.

PATCH/users/restore

Body

application/json

User restoration data

ids*array of number

Array of IDs

Response

200400403500

Users restored successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/users/restore', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ids": [
        1,
        2,
        3
      ]
    }),
});
const data = await response.json();

Response

200400403500

{
  "message": "Users restored successfully",
  "description": "<p>The users have been restored successfully.</p>",
  "__$markdownParsed": true
}

Toggles the tour completion status for the authenticated user.

PATCH/users/tour

Response

200404500

Tour completion status toggled successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/users/tour', {
    method: 'PATCH',
    headers: {},
});
const data = await response.json();

Response

200404500

{
  "message": "Tour completion status toggled successfully",
  "description": "<p>The tour completion status has been toggled successfully.</p>",
  "__$markdownParsed": true
}

PUT

Updates a user.

PUT/users/update-user

Body

application/json

User update data

User (object)

Response

200400404

User updated successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/users/update-user', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400404

{
  "message": "User updated successfully",
  "description": "<p>The user has been updated successfully.</p>",
  "__$markdownParsed": true
}

Updates the profile of the authenticated user.

PUT/users/update-profile

Body

application/json

Profile update data

firstName*nullable string

First name of the user

Example: "John"

lastName*nullable string

Last name of the user

Example: "Doe"

email*nullable string

Email of the user

Example: "[e-mail]"

photo*nullable string

Photo of the user

Example: "photo.jpg"

phoneNumber*nullable string

Phone number of the user

Example: "123-456-7890"

impersonationAllowed*nullable boolean

Indicates if impersonation is allowed for the user

Example: true

Response

200400

Profile updated successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/users/update-profile', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "firstName": "John",
      "lastName": "Doe",
      "email": "[e-mail]",
      "photo": "photo.jpg",
      "phoneNumber": "123-456-7890",
      "impersonationAllowed": true
    }),
});
const data = await response.json();

Response

200400

{
  "message": "Profile updated successfully",
  "description": "<p>The profile has been updated successfully.</p>",
  "__$markdownParsed": true
}

DELETE

Deletes multiple users.

DELETE/users

Body

application/json

User deletion data

ids*array of number

Array of IDs

Response

200400403500

Users deleted successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/users', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ids": [
        1,
        2,
        3
      ]
    }),
});
const data = await response.json();

Response

200400403500

{
  "message": "Users deleted successfully",
  "description": "<p>The users have been deleted successfully.</p>",
  "__$markdownParsed": true
}

Deletes a photo by its file name.

DELETE/users/delete-photo/{fileName}

Path parameters

fileName*string

Response

200404500

Photo deleted successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/users/delete-photo/{fileName}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200404500

{
  "message": "Photo deleted successfully",
  "description": "<p>The photo has been deleted successfully.</p>",
  "__$markdownParsed": true
}