User Admin

GET

Retrieves all user roles.

get

Responses

200

User roles retrieved successfully

application/json

get

/users/user-roles

HTTPcURLJavaScriptPython

GET /users/user-roles HTTP/1.1
Host: 
Accept: */*

200

User roles retrieved successfully

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

Searches for users based on the provided search term.

get

Responses

200

Users retrieved successfully

application/json

400

Invalid search term

application/json

get

/users/search

HTTPcURLJavaScriptPython

GET /users/search HTTP/1.1
Host: 
Accept: */*

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

Retrieves a user by their ID.

get

Path parameters

idstringRequired

Responses

200

User retrieved successfully

application/json

400

Invalid user ID

application/json

404

User not found

application/json

get

/users/{id}

HTTPcURLJavaScriptPython

GET /users/{id} HTTP/1.1
Host: 
Accept: */*

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

Retrieves a photo by its file name.

get

Path parameters

fileNamestringRequired

Responses

200

Photo retrieved successfully

application/json

Responsestring · binary

404

Photo not found

application/json

get

/users/get-photo/{fileName}

HTTPcURLJavaScriptPython

GET /users/get-photo/{fileName} HTTP/1.1
Host: 
Accept: */*

binary

POST

Retrieves all users based on the provided search parameters.

post

Body

application/json

isDeletedbooleanRequired

Indicates if deleted users should be included

Example: false

globalSearchstring | nullableRequired

Global search term

Example: search term

sortFieldstring | nullableRequired

Field to sort by

Example: createdAt

sortOrderstring · enum | nullableRequired

Order to sort by

Example: ASCPossible values:

Responses

200

Users retrieved successfully

application/json

400

Invalid search parameters

application/json

post

/users

HTTPcURLJavaScriptPython

POST /users HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "isDeleted": false,
  "globalSearch": "search term",
  "status": [
    "Active"
  ],
  "roles": [
    "Admin",
    "User"
  ],
  "sortField": "createdAt",
  "sortOrder": "ASC"
}

{
  "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

Body

application/json

photostring · binaryOptional

Responses

200

Photo uploaded successfully

application/json

ResponsestringExample: formatted_file_name.jpg

400

Invalid file

application/json

post

/users/upload-photo

HTTPcURLJavaScriptPython

POST /users/upload-photo HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "photo": "binary"
}

formatted_file_name.jpg

PATCH

Archives multiple users.

patch

Body

application/json

idsnumber[]RequiredExample: [1,2,3]

Responses

200

Users archived successfully

application/json

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

400

One or more users not found

application/json

403

Access denied

application/json

500

Internal server error

application/json

patch

/users/archive

HTTPcURLJavaScriptPython

PATCH /users/archive HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "ids": [
    1,
    2,
    3
  ]
}

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

Restores multiple archived users.

patch

Body

application/json

idsnumber[]RequiredExample: [1,2,3]

Responses

200

Users restored successfully

application/json

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

400

One or more users not found

application/json

403

Access denied

application/json

500

Internal server error

application/json

patch

/users/restore

HTTPcURLJavaScriptPython

PATCH /users/restore HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "ids": [
    1,
    2,
    3
  ]
}

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

Toggles the tour completion status for the authenticated user.

patch

Responses

200

Tour completion status toggled successfully

application/json

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

404

User not found

application/json

500

Internal server error

application/json

patch

/users/tour

HTTPcURLJavaScriptPython

PATCH /users/tour HTTP/1.1
Host: 
Accept: */*

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

PUT

Updates a user.

put

Body

application/json

idnumberOptionalExample: 1

roleIdsnumber[] | nullableOptionalExample: [1,2,3]

Responses

200

User updated successfully

application/json

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

400

Invalid user data

application/json

404

User not found

application/json

put

/users/update-user

HTTPcURLJavaScriptPython

PUT /users/update-user HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "id": 1,
  "roleIds": [
    1,
    2,
    3
  ]
}

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

Updates the profile of the authenticated user.

put

Body

application/json

firstNamestring | nullableRequiredExample: John

lastNamestring | nullableRequiredExample: Doe

emailstring | nullableRequiredExample: [e-mail]

photostring | nullableRequiredExample: photo.jpg

phoneNumberstring | nullableRequiredExample: 123-456-7890

impersonationAllowedboolean | nullableRequiredExample: true

Responses

200

Profile updated successfully

application/json

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

400

User not found

application/json

put

/users/update-profile

HTTPcURLJavaScriptPython

PUT /users/update-profile HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 145

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "[e-mail]",
  "photo": "photo.jpg",
  "phoneNumber": "123-456-7890",
  "impersonationAllowed": true
}

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

DELETE

Deletes multiple users.

delete

Body

application/json

idsnumber[]RequiredExample: [1,2,3]

Responses

200

Users deleted successfully

application/json

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

400

One or more users not found

application/json

403

Access denied

application/json

500

Internal server error

application/json

delete

/users

HTTPcURLJavaScriptPython

DELETE /users HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "ids": [
    1,
    2,
    3
  ]
}

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

Deletes a photo by its file name.

delete

Path parameters

fileNamestringRequired

Responses

200

Photo deleted successfully

application/json

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

404

Photo not found

application/json

500

Internal server error

application/json

delete

/users/delete-photo/{fileName}

HTTPcURLJavaScriptPython

DELETE /users/delete-photo/{fileName} HTTP/1.1
Host: 
Accept: */*

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