Editing user
- Print
- PDF
Editing user
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
You can edit user information.
Requests
- PUT /users/{userId}
Request path
| Parameters | Requirement status | Type | Description | Restrictions |
|---|---|---|---|---|
| userId | Y | String | User ID |
Request bodies
{
"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 |
|---|---|---|---|---|
| description | N | String | User description | Up to 300 bytes |
| userProfile | N | Object | User profile | |
| userProfile.firstName | N | String | First name | Up to 200 bytes |
| userProfile.lastName | N | String | Last name | Up to 200 bytes |
| userProfile.email | N | String | Up to 200 bytes, email format only | |
| userProfile.empNo | N | String | Employee number | Up to 200 bytes |
| userProfile.phoneCountryCode | N | String | Country code for mobile phone number | Up to 10 bytes, country code format only |
| userProfile.phoneNo | N | String | Mobile phone number | Up to 200 bytes, mobile phone number format only |
| userProfile.deptName | N | String | Department name | Up to 200 bytes |
| accessRules | Y | Object | Access rules | |
| accessRules.consoleAccessAllowed | Y | Boolean | Whether console access is allowed | |
| accessRules.apiAccessAllowed | Y | Boolean | Whether API access is allowed |
Responses
Response bodies
{
"id": "String",
"nrn": "String",
"success" : "boolean"
}
| Parameters | Type | Description |
|---|---|---|
| id | String | User ID |
| nrn | String | nrn of the edited 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. |
| 400 | 9050 | The user does not exist. |
Was this article helpful?