The store user authentication operation will update a user's authentication credential with the specified request body.
Request
Request URI
| Method | Request URI |
|---|---|
| POST | https://{company-name}.helloid.com/api/v1/users/addUserCredentials/{userName} |
| POST | https://{company-name}.helloid.com/api/v1/users/addUserCredentials/{userGUID} |
| POST | https://{company-name}.helloid.com/api/v1/users/addUserCredentialsByUserSid/{adSid} |
Request parameters
| Parameter | Description |
|---|---|
| {company-name} | The company name of the target company |
| {userName} | The username of the user |
| {userGUID} | The user GUID of the user |
| {adSid} | The adSid of the user |
Request headers
| Header | Description |
|---|---|
| Content-Type | Required. Must be set to application/json |
Sample request body
{
"userName": "Joey",
"password": "$eCreTP@$$W0rD"
}
Request body parameters
| Parameter | Description | Required / Optional | Default value |
|---|---|---|---|
| {userName} | Username of the user | Required | - |
| {password} | Password of the user | Required | - |
Response
Response status
| Code | Description |
|---|---|
| 200(OK) | Indicates that the operation was successful and the resource is created. |
| 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) | Indicates that user could not be found by this username. |
Please also see error result.
Please also see common HTTP status codes.
Example request with cURL
Replace placeholder values surrounded by { } with the actual values.
curl -u {api-key}:{api-secret} -X POST https://{company-name}.helloid.com/api/v1/users/{userName}
-H "Content-Type:application/json" -d
"{
'userName': '{userName}',
'password': '{password}'
}"