Update User¶
Warning
This API is not allowed for contracts which was applied via NTT Communications business portal. In this case, if you need to update user’s email, update user email on NTT Communications business portal, then SSO this service.
Overview¶
Update user information.
Classification¶
- Update
API Operation Object¶
- user
Synchronous / Asynchronous¶
- Synchronous
Request¶
HTTP Request Method¶
- PUT
HTTP Request Path¶
{api_endpoint}/api/v2/users/{user_id}
HTTP Request Header¶
X-Auth-Token: <token_id>
Content-Type: application/json
HTTP Request Body¶
{
"login_id": "test001",
"mail_address": "test@ntt.com",
"new_password": "Ale39bao"
}
Request Parameter¶
item | mandatory | format | description |
login_id | String | New login id of the user. | |
mail_address | String | New email address of the user | |
new_password | String | Password of the user. Single-byte alphanumeric characters, and !#$%&()*+,-./:;<=>?@[]^_`{|}~ can be used. Must contain at least one uppercase letter, one lowercase letter, and one number. String length must be between 8 and 50 characters. |
Response¶
Response Header¶
Format¶
HTTP/1.1 <response_code> <response_code> (ex. 200 200)
- <response_code>: see “HTTP Responses” section
- <message>: message based on the response code
(skip auto insert field such as “Connection” and “Content-Length”, “Set-Cookie”, etc.)
Response Code¶
response code | condition |
---|---|
204 | No Content |
400 | request format is invalid |
- | invalid tenant id |
- | specified invalid instance id for marker query |
- | specified non integer for limit query |
401 | unauthorized |
403 | Not permitted for this user |
404 | not found a specified resource |
405 | Method not allowed |
409 | designated login conflicts existing user |
Sample Request and Response¶
Sample API Request¶
curl -1 -i -X PUT -H"Content-Type: application/json" -H"X-Auth-Token: dec164faee114049ab3d33edcb7aea0e" -d '{
"mail_address": "new.eamil@ntt.com"
}' https://sss-jp1-ecl.api.ntt.com/api/v2/users/ecid1000014777
Sample API Response¶
HTTP/1.1 204 204
Date: Sun, 28 Feb 2016 06:44:42 GMT
Content-Length: 0
Connection: keep-alive
Set-Cookie: TS0183560f=01059ca7b1a103f367bc3180abb894cfd989823e8191711e24b8ceaf71dbca4e5e14e58297; Path=/
Sample Error Message¶
HTTP/1.1 404 404
Date: Sun, 28 Feb 2016 06:49:15 GMT
Content-Type: application/json
Content-Length: 65
Connection: keep-alive
Set-Cookie: TS0183560f=01059ca7b1ed53ac249469b039129391e114cfb554d76696527ba0f77fd9cad3941fdf6d78; Path=/
{"code":404,"title":"Not Found","message":"User does not exist."}