Nhảy tới nội dung
Phiên bản: 1.0.0

Lấy danh sách người dùng

Ngày cập nhật: 30 tháng 4, 2023
Người cập nhật: VNPT eContract's team


Mục đích: Hàm thực hiện lấy danh sách người dùng của công ty

  • Request URL: /api/users
  • HTTP method: GET
  • Authorize: Bearer token
  • Parameter: Không yêu cầu, tuy nhiên có thể thêm các tùy chọn bên dưới để thực hiện lọc hoặc tìm kiếm danh sách người dùng.
KeyTypeDescription
searchstringThông tin tìm kiếm theo người dùng, tên người dùng và số điện thoại
statusintTrạng thái người dùng
1: Hoạt động
-1: Ngưng hoạt động
signMethodintPhương pháp ký
1: (Only old version) Sign draw
2: VNPT Smart CA
3: Ký số USB Token
userGroupIdintId nhóm người dùng
departmentIdintId bộ phận
certStatusintTrạng thái chứng thư số tự ký
0: Không có
1: Đã có
2: Hết hạn
pageintSố trang cần lấy dữ liệu (Mặc định hệ thống đang là 1)
pageSizeintSố record dữ liệu mà hệ thống sẽ trả về sau mỗi request (Mặc định hệ thống đang là 10 record)

Mẫu request

Query param:
page: 1
pageSize:10
search: baoth
Request: /api/users?page=1&pageSize=10&search=baoth

Mẫu response body

{
"data": {
"items": [
{
"id": 1163,
"createdDate": "2021-08-12T14:46:22.7857729",
"comId": 164,
"code": "baoth",
"name": "Tô Hoài Bảo",
"phone": "0942503973",
"email": "baothzz@email.com",
"validFrom": "2022-08-22T12:01:00",
"validTo": "2023-08-22T12:01:00",
"isValid": true,
"signConfirmationEnabled": true,
"isAccountLocked": false,
"signMethod": {
"value": 2,
"description": "VNPT Smart CA"
},
"status": {
"value": 1,
"description": "Enabled"
},
"receiveOtpMethod": {
"value": 1,
"description": "Email"
},
"receiveNotificationMethod": {
"value": 0,
"description": "Email"
},
"personalCertificateId": 2028,
"smartCaId": 2012
}
],
"totalCount": 1,
"pageCount": 1,
"page": 1,
"pageSize": 10,
"hasNextPage": false,
"hasPreviousPage": false
},
"success": true,
"code": 0,
"messages": []
}