The update user operation will update an user (specified with request parameter) with the specified request body.
Request
Request URI
| Method | Request URI |
|---|---|
| PUT | https://{company-name}.helloid.com/api/v1/users/{username} |
| PUT | https://{company-name}.helloid.com/api/v1/users/{userGuid} |
| PUT | https://{company-name}.helloid.com/api/v1/users/{adsid} |
| PUT | https://{company-name}.helloid.com/api/v1/users/{userId} |
Request parameters
| Parameter | Description |
|---|---|
| {company-name} | The company name of the target company |
| {username} | The user name of the user you want to update. |
| {userGuid} | The user guid of the user you want to update. |
| {adsid} | The SID of the user you want to update |
| {userId} | The user id of the user you want to update. |
Request headers
| Header | Description |
|---|---|
| Content-Type | Required. Must be set to application/json. |
Sample request body
{
"firstName": "Joey",
"lastName": "Doe",
"password": "hfDXpNYLUEGcar[Hh+7)e}N[,Sp*;^jZ",
"options": 0,
"isEnabled": true,
"isLocked": false,
"resetMFA" : false,
"mustChangePassword": false,
"contactEmail": "j.doe@email.com",
"userAttributes": {
"PhoneNumber": "003112300456"
}
}
Request body parameters
| Parameter | Description | Required/Optional | Default value |
|---|---|---|---|
| {firstName} | First name of the user | Optional | - |
| {lastName} | Last name of the user | Optional | - |
| {password} | password of the user. Without the password the user can not sign in to HelloID | Optional | - |
| {isEnabled} | Is the user enabled or disabled. | Optional | - |
| {isLocked} | Set to true to unlock the user account. | Optional | - |
| {mustChangePassword} | Should the user change the password on the next sign in. | Optional | - |
| {contactEmail} | The contact e-mail address of the user. | Optional | - |
| {userAttributes} | Custom attributes of a the user. Like a Phone Number. | Optional | - |
| {resetMFA} | Reset (all) the MFA enabled for this user. | Optional | - |
Request body parameters
HelloID will only update fields of the user that are present in the request body.Response
Response status
| Code | Description |
|---|---|
| 200(OK) | Indicates that the operation was successful and the resource is updated. |
| 400(BAD REQUEST) | Indicates that the operation was not successful. There were validation errors or the request body was malformed.If there were validation errors, the response will include a error result. |
| 401(UNAUTHORIZED) | Indicates that no authentication header was given or the api key and secret were invalid. If the api key and secret were valid check the configuration in your portal, it is possibilty these were IP restricted or are disabled. |
| 404(NOT FOUND) | The operation was not successful. The user has not been found. |
Please also see error result.
Please also see common HTTP status codes.
Sample response body
{
"id": 1,
"userGUID": "3216f4b1-c290-4b6f-8ddb-921889331f56",
"lastLogin": "2016-02-26T13:43:35.437",
"source": "API",
"links": [{
"title": "self",
"location": "/api/v1/users/3216f4b1-c290-4b6f-8ddb-921889331f56"
}, {
"title": "self",
"location": "/api/v1/users/J.Doe"
}, {
"title": "self",
"location": "/api/v1/users/1"
}, {
"title": "self",
"location": "/api/v1/users/S-1-5-21-000000000-0000000000-000000000-0000"
}, {
"title": "All users",
"location": "/api/v1/users/"
}],
"firstName": "Joey",
"lastName": "Doe",
"userName": "J.Doe",
"managedByUserGUID": "178cb594-09b1-4645-892a-9fe6a8eb8a08",
"isEnabled": true,
"isDeleted": false,
"isLocked": false,
"mustChangePassword": false,
"lockTime": null,
"passwordLastSetTime": null,
"roles": ["User"],
"adsid": "S-1-5-21-000000000-0000000000-000000000-0000",
"contactEmail": "j.doe@email.com",
"userAttributes": {
"PhoneNumber": "003112300456"
}
}
Link property
The link property is a navigational property. It shows all locations where this resource can be found.Example request with cURL
Replace placeholder values surrounded by { } with the actual values.
curl -u {api-key}:{api-secret} -X PUT https://{company-name}.helloid.com/api/v1/users/{username}
-H "Content-Type:application/json" -d
"{
'userName': '{userName}',
'firstName': '{firstName}'
}"