User Admin

GET

Retrieves all user roles.

get

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/users/user-roles'

200

200

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

User roles retrieved successfully

Searches for users based on the provided search term.

get

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/users/search'

200

400

200

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

Users retrieved successfully

Retrieves a user by their ID.

get

Path parameters

idstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/users/{id}'

200

400

404

200

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

User retrieved successfully

Retrieves a photo by its file name.

get

Path parameters

fileNamestringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/users/get-photo/{fileName}'

200

404

200

binary

Photo retrieved successfully

POST

Retrieves all users based on the provided search parameters.

post

Body

isDeletedbooleanrequired

Indicates if deleted users should be included

Example: false

globalSearchstring | nullablerequired

Global search term

Example: search term

statusstring · enum[] | nullablerequired

Status of the accounts

Example: ["Active"]

rolesstring · enum[] | nullablerequired

Roles of the users

Example: ["Admin","User"]

sortFieldstring | nullablerequired

Field to sort by

Example: createdAt

sortOrderstring · enum | nullablerequired

Order to sort by

Example: ASC

Available options:

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/users' \
  --header 'Content-Type: application/json' \
  --data '{
    "isDeleted": false,
    "globalSearch": "search term",
    "status": [
      "Active"
    ],
    "roles": [
      "Admin",
      "User"
    ],
    "sortField": "createdAt",
    "sortOrder": "ASC"
  }'

200

400

200

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

Users retrieved successfully

Uploads a photo for the authenticated user.

post

Body

photostring · binaryoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/users/upload-photo' \
  --header 'Content-Type: application/json' \
  --data '{
    "photo": "binary"
  }'

200

400

200

formatted_file_name.jpg

Photo uploaded successfully

PATCH

Archives multiple users.

patch

Body

idsnumber[]required

Example: [1,2,3]

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/users/archive' \
  --header 'Content-Type: application/json' \
  --data '{
    "ids": [
      1,
      2,
      3
    ]
  }'

200

400

403

500

200

{
  "message": "Users archived successfully",
  "description": "The users have been archived successfully."
}

Users archived successfully

Restores multiple archived users.

patch

Body

idsnumber[]required

Example: [1,2,3]

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/users/restore' \
  --header 'Content-Type: application/json' \
  --data '{
    "ids": [
      1,
      2,
      3
    ]
  }'

200

400

403

500

200

{
  "message": "Users restored successfully",
  "description": "The users have been restored successfully."
}

Users restored successfully

Toggles the tour completion status for the authenticated user.

patch

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/users/tour'

200

404

500

200

{
  "message": "Tour completion status toggled successfully",
  "description": "The tour completion status has been toggled successfully."
}

Tour completion status toggled successfully

PUT

Updates a user.

put

Body

idnumberoptional

Example: 1

roleIdsnumber[] | nullableoptional

Example: [1,2,3]

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/users/update-user' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": 1,
    "roleIds": [
      1,
      2,
      3
    ]
  }'

200

400

404

200

{
  "message": "User updated successfully",
  "description": "The user has been updated successfully."
}

User updated successfully

Updates the profile of the authenticated user.

put

Body

firstNamestring | nullablerequired

Example: John

lastNamestring | nullablerequired

Example: Doe

emailstring | nullablerequired

Example: [e-mail]

photostring | nullablerequired

Example: photo.jpg

phoneNumberstring | nullablerequired

Example: 123-456-7890

impersonationAllowedboolean | nullablerequired

Example: true

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/users/update-profile' \
  --header 'Content-Type: application/json' \
  --data '{
    "firstName": "John",
    "lastName": "Doe",
    "email": "[e-mail]",
    "photo": "photo.jpg",
    "phoneNumber": "123-456-7890",
    "impersonationAllowed": true
  }'

200

400

200

{
  "message": "Profile updated successfully",
  "description": "The profile has been updated successfully."
}

Profile updated successfully

DELETE

Deletes multiple users.

delete

Body

idsnumber[]required

Example: [1,2,3]

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/users' \
  --header 'Content-Type: application/json' \
  --data '{
    "ids": [
      1,
      2,
      3
    ]
  }'

200

400

403

500

200

{
  "message": "Users deleted successfully",
  "description": "The users have been deleted successfully."
}

Users deleted successfully

Deletes a photo by its file name.

delete

Path parameters

fileNamestringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/users/delete-photo/{fileName}'

200

404

500

200

{
  "message": "Photo deleted successfully",
  "description": "The photo has been deleted successfully."
}

Photo deleted successfully