createAccount: хэрэглэгчийн бүртгэл үүсгэх
Энэ хуудсыг AI-аар орчуулж, автоматаар шалгасан. Нарийн тохиргоо хийхээсээ өмнө англи эхтэй тулгаж болно.
Энэ method-оор хэрэглэгчийн бүртгэл үүсгэж, нууц үг оноож болно.
Параметрүүд
| Параметр | Тайлбар | Хүсэлтэд | Төрөл | Утга |
|---|---|---|---|---|
| Шинэ бүртгэлийн и-мэйл хаяг. | Заавал | String | Нэмэлт шаардлагагүй. Жишээ: "email": "client@bitdefender.com" | |
| userName | Бүртгэлийн хэрэглэгчийн нэр. | Заавал | String | Зөвхөн дараах тэмдэгтүүдийг ашиглаж болно: аль ч хэлний үсэг, цифр, зай, мөн тусгай тэмдэгтүүд: @ , ! , # , $ , % , & , ' , * , + , - , . , / , \ , [ , ] болон |. Жишээ: "userName":"Client" |
| profile | Профайлын мэдээллийг агуулсан объект. | Заавал | Object | profile хэсгийг үз. Жишээ: "profile": { "fullName": "Bitdefender User", "language": "en_US", "timezone": "Europe/Bucharest" }, |
| phoneNumber | Утасны дугаарын мэдээллийг агуулсан объект. | Заавал биш | Object | phoneNumber хэсгийг үз. Жишээ: "phoneNumber": { "countryCode": "+40", "subscriberNumber": "0000000000" }, |
| password | Шинэ бүртгэлийн нууц үг. Энэ утгыг орхивол нууц үг үүсгэж хэрэглэгчид и-мэйлээр илгээнэ. | Заавал биш | String | Нууц үг дор хаяж арван хоёр тэмдэгттэй байх ба нэг том үсэг, нэг жижиг үсэг, нэг цифр, нэг тусгай тэмдэгт агуулсан, өмнө ашиглаж байсан нууц үгээс өөр байх ёстой. Жишээ: "password": "P@s4w0rd" |
| role | Шинэ бүртгэлийн дүр (role). Хэрэглэгчийн дүр болон холбогдох эрхийн талаар User roles хэсгээс үз. | Заавал биш | Number | Боломжит утга: 1 - Company Administrator, 2 - Network Administrator, 3 - Reporter, 5 - Custom. Энэ параметрт 5 гэж оноосон бол хүсэлтэд rights параметрийг мөн оруулах ёстой. Өгөгдмөл утга: 1. Жишээ: "role": 5 |
| rights | Хэрэглэгчийн бүртгэлийн эрхүүдийг агуулсан объект. Зөвхөн хүсэлтэд role параметр орсон бөгөөд утга нь 5 үед ашиглана. Бусад тохиолдолд rights параметрт оноосон утгыг үл тоомсорлоно. | Заавал биш | Object | rights хэсгийг үз. Жишээ: "rights": { "manageInventory": true, "managePoliciesRead": true, "managePoliciesWrite": true, "manageReports": true, "manageUsers": false }, |
| targetIds | Хэрэглэгчийн бүртгэлээр удирдах объектуудын ID-ийн жагсаалт. | Заавал биш | Array | Нэмэлт шаардлагагүй. Жишээ: "targetIds": [ "585d2dc9aaed70820e8b45b4", "585d2dd5aaed70b8048b45ca" ] |
Ерөнхий параметрүүд
Эдгээр нь Public API-ийн бүх method-д нийтлэг байдаг параметрүүд юм.
| Параметр | Тайлбар | Хүсэлтэд | Төрөл | Утгын шаардлага |
|---|---|---|---|---|
| id | Хүсэлтэд танигч нэмж, түүнийг хариутай нь холбоно. Зорилтот систем хариунд ижил утгыг буцаах тул дуудлагыг амархан хянах боломжтой. | Заавал | String | Нэмэлт шаардлагагүй. Жишээ: "id": "ad12cb61-52b3-4209-a87a-93a8530d91cb" |
| method | Хүсэлт илгээхэд ашиглаж буй method-ын нэр. | Заавал | String | Хүчинтэй method-ын нэр байх ёстой. Жишээ: "method": "methodName" |
| jsonrpc | Хүсэлт ба хариуны ашигласан JSON-RPC хувилбар. | Заавал | Integer | Цорын ганц боломжит утга: 2.0. Жишээ: "jsonrpc": "2.0" |
| params | Хүсэлтийн тохиргоог агуулсан объект. | Заавал | Object | Нэмэлт шаардлагагүй. Жишээ: "params": {...} |
| params объектын дотор | ||||
| page | Үр дүнгийн хуудасны дугаар. | Заавал биш | Integer | Өгөгдмөл утга: 1. |
| perPage | Нэг хуудсанд харуулах үр дүнгийн тоо. | Заавал биш | Integer | Дээд хязгаар нь нэг хуудсанд 100 зүйл. Өгөгдмөл утга: 30. |
Объектууд
profile
| Нэр | Тайлбар | Хүсэлтэд | Төрөл |
|---|---|---|---|
| fullName | Хэрэглэгчийн бүтэн нэр. | Заавал | String |
| timezone | Хэрэглэгчийн цагийн бүс. | Заавал биш | String |
| language | GravityZone console-д харуулах хэл. | Заавал биш | String |
phoneNumber
| Нэр | Тайлбар | Хүсэлтэд | Төрөл |
|---|---|---|---|
| countryCode | Утасны дугаар байрлах улсын код (угтвар). | Заавал | String |
| subscriberNumber | Угтваргүй утасны дугаар. | Заавал | String |
rights
| Нэр | Тайлбар | Хүсэлтэд | Төрөл |
|---|---|---|---|
| manageNetworks | Анхаар: manageNetworks атрибут хуучирсан (deprecated). Оронд нь manageInventory, managePoliciesRead, managePoliciesWrite атрибутуудыг ашиглахыг зөвлөж байна. Сүлжээний аюулгүй байдлын дараах тохиргоонд администраторын эрх олгоно: сүлжээний инвентар (Network inventory), бодлогууд (Policies), даалгаврууд (Tasks), суулгалтын багцууд (Installation packages), хорио (Quarantine). true гэж тохируулбал manageReports эрх автоматаар ижил утгыг авна. manageNetworks байвал түүний утгыг manageInventory, managePoliciesRead, managePoliciesWrite атрибутуудад автоматаар оноодог. Нэг хүсэлтэд эдгээр гурвын аль нэгэнд өөр утга оноовол алдаа гарна. Өгөгдмөл утга: false. | Заавал биш | Boolean |
| manageUsers | Хэрэглэгч өөрийн компанийн хэрэглэгчийн бүртгэлийг үүсгэх, устгах, засах боломжтой болно. Өгөгдмөл утга: false. | Заавал биш | Boolean |
| manageReports | Хэрэглэгч өөрийн компанийн тайланг үүсгэх, харах, засах боломжтой болно. Өгөгдмөл утга: false. | Заавал биш | Boolean |
| companyManager | Хэрэглэгч өөрийн компанийн профайлын тохиргоог засах, лицензийн өөрчлөлт хийх боломжтой болно. Өгөгдмөл утга: false. | Заавал биш | Boolean |
| manageRemoteShell | Хэрэглэгч удирдагдаж буй төгсгөлийн төхөөрөмж (endpoint) дээр Remote Shell сесс эхлүүлж, нарийвчилсан шинжилгээ (forensics) хийх боломжтой болно. true гэж тохируулбал manageNetworks атрибут автоматаар true болно. Өгөгдмөл утга: false. | Заавал биш | Boolean |
| manageInventory | Сүлжээний инвентар, даалгавар, суулгалтын багц, хорионд орсон зүйлсэд администраторын эрх олгоно. manageNetworks байгаа үед хүсэлтэд оруулж болохгүй. Өгөгдмөл утга: false. | Заавал биш | Boolean |
| managePoliciesRead | Хэрэглэгч компанийн бодлогуудыг харах боломжтой болно. manageNetworks байгаа үед хүсэлтэд оруулж болохгүй. Өгөгдмөл утга: false. | Заавал биш | Boolean |
| managePoliciesWrite | Хэрэглэгч компанийн бодлогыг үүсгэх, засах боломжтой болно. Утгыг true болговол managePoliciesRead параметрийн утга мөн true байх ёстой. managePoliciesRead атрибутыг оруулаагүй эсвэл өөр утга оноовол алдаа гарна. manageNetworks байгаа үед хүсэлтэд оруулж болохгүй. Өгөгдмөл утга: false. | Заавал биш | Boolean |
Буцаах утга
| Атрибут | Төрөл | Тайлбар |
|---|---|---|
| result | String | Үүсгэсэн хэрэглэгчийн бүртгэлийн ID. |
Жишээ
Хүсэлт
{
"id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
"jsonrpc": "2.0",
"method": "createAccount",
"params": {
"email": "client@bitdefender.com",
"userName":"Client"
"profile": {
"fullName": "Bitdefender User",
"language": "en_US",
"timezone": "Europe/Bucharest"
},
"phoneNumber": {
"countryCode": "+40",
"subscriberNumber": "0000000000"
},
"password": "P@s4w0rd",
"role": 5,
"rights": {
"manageInventory": true,
"managePoliciesRead": true,
"managePoliciesWrite": true,
"manageReports": true,
"manageUsers": false,
},
"targetIds": [
"585d2dc9aaed70820e8b45b4",
"585d2dd5aaed70b8048b45ca"
]
}
}Хариу
{
"id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
"jsonrpc": "2.0",
"result": "585d2dc9aaed70820abc45b4"
}Энэ хуудсанд гарсан нэр томъёо
- Endpoint
- Хамгаалж буй компьютер, сервер, виртуал машин
- Policy
- Хамгаалалтын тохиргооны багц; төхөөрөмж эсвэл бүлэгт оноодог
- Network
- Таны байгууллагын бүх төхөөрөмжийн жагсаалт (Inventory)
- Quarantine
- Хорио: сэжигтэй файлыг тусгаарлаж хадгалдаг газар
- Installation package
- Агент суулгах файл; Control Center-оос үүсгэнэ