Creating users in batch
- Print
- PDF
Creating users in batch
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
You can create multiple users in batch.
Requests
- POST /users/bulk
Request bodies
{
"params": [
{
"loginId": "string",
"description": "string",
"userProfile": {
"firstName": "string",
"lastName": "string",
"email": "string",
"empNo": "string",
"phoneCountryCode": "string",
"phoneNo": "string",
"deptName": "string"
},
"accessRules": {
"consoleAccessAllowed": "boolean",
"apiAccessAllowed": "boolean"
}
}
]
}
| Parameters | Requirement status | Type | Description | Restrictions |
|---|---|---|---|---|
| params.[].loginId | Y | String | Login ID | email format |
| params.[].description | N | String | User description | Up to 300 bytes |
| params.[].userProfile | N | Object | User profile | |
| params.[].userProfile.firstName | N | String | First name | Up to 200 bytes |
| params.[].userProfile.lastName | N | String | Last name | Up to 200 bytes |
| params.[].userProfile.email | N | String | Up to 200 bytes, email format only | |
| params.[].userProfile.empNo | N | String | Employee number | Up to 200 bytes |
| params.[].userProfile.phoneCountryCode | N | String | Country code for mobile phone number | Up to 10 bytes, country code format only |
| params.[].userProfile.phoneNo | N | String | Mobile phone number | Up to 200 bytes, mobile phone number format only |
| params.[].userProfile.deptName | N | String | Department name | Up to 200 bytes |
| params.[].accessRules | Y | Object | Access rules | |
| params.[].accessRules.consoleAccessAllowed | Y | Boolean | Whether console access is allowed | |
| params.[].accessRules.apiAccessAllowed | Y | Boolean | Whether API access is allowed |
- Up to 100 users can be created.
Responses
Response bodies
[{
"id": "String",
"nrn": "String",
"name": "String",
"success" : "boolean"
}]
| Parameters | Type | Description | Restrictions |
|---|---|---|---|
| [].id | String | ID of the created user | |
| [].nrn | String | nrn of the created user | |
| [].name | String | Login ID of the created user | |
| [].success | Boolean | Whether it is a success | |
| [].message | String | Failure error message |
Errors
Errors that may occur while using this action are listed below. For error response format, see ErrorResponse.
For more information on common errors, see NAVER Cloud Platform API.
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | 400 | Invalid request. |
Was this article helpful?