The UpdateEndUserCredentialConfigurationForApplication operation will update the credential configuration for a given application and end user.
Request
Request URI
| Method | Request URI |
|---|---|
| POST | https://{company-name}.helloid.com/api/v1/enduser/{user-guid}/credential |
Request parameters
| Parameter | Description |
|---|---|
| {company-name} | The company name of the target company |
| {user-guid} | The GUID of the end user |
Request headers
| Header | Description |
|---|---|
| Content-Type | Required. Must be set to application/json. |
Sample Request body
{
"ApplicationGUID": "6c9e917d-e4b0-44e6-83aa-6f01c6ea314f",
"CredSetName": "Default",
"Credentials": [{
"Function": "UserName",
"Value": "Mike",
"UserEditAllowed": true
}, {
"Function": "Password",
"Value": "g!sg*Z_x5",
"UserEditAllowed": true
}]
}
Request body parameters
| Parameter | Description | Required/Optional |
|---|---|---|
| ApplicationGUID | The GUID of the application | required |
| CredSetName | Name of the credential set | required |
| Credentials | Array with objects containing the credential attributes | required |
| Function | Function of the credential (like username or password) | required |
| Value | Value for the new credential | required |
| UserEditAllowed | Must always be set to true | required |
Response
Response status
| Code | Description |
|---|---|
| 200(OK) | Indicates that the operation was successful. |
| 400(BAD REQUEST) | Indicates that the operation was not successful. There were validation errors or the request body was malformed. |
| 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. |
Please also see common HTTP status codes.
Sample response body
[
{
"langSet": "EN",
"credentialSets": [
{
"credentials": [
{
"credentialGUID": "4cef57a3-57e5-49c8-8844-ecf851664ea8",
"function": "UserName",
"value": "Mike",
"userEditAllowed": true
},
{
"credentialGUID": "075b32ee-4b20-46d4-b95a-7692070b23e8",
"function": "Password",
"value": "g!sg*Z_x5",
"userEditAllowed": true
}
],
"credentialSetGUID": "c7e4de0c-b8d8-4d1b-9a62-6eead6502e1e",
"name": "Default"
}
],
"credCount": 2,
"custom": "ewoJICAiZmllbGRzIjogWwoJCXsKCQkia2V5IjogImxvZ2luX2ZpZWxkIiwKCQkidHlwZSI6ICJ1c2VybmFtZSIKCQl9LAoJCXsKCQkia2V5IjogInBhc3N3b3JkIiwKCQkidHlwZSI6ICJwYXNzd29yZCIKCQl9LAoJCXsKCQkia2V5IjogImNvbW1pdCIsCgkJInR5cGUiOiAic3VibWl0IgoJCX0KCQldCgkJfQogICAgICAgIA==",
"changePwdScript": "ewoJCSJmaWVsZHMiOiBbCgkJewoJCSJrZXkiOiAidXNlcl9vbGRfcGFzc3dvcmQiLAoJCSJ0eXBlIjogInBhc3N3b3JkIgoJCX0sCiAgICAgICAgewoJCSJrZXkiOiAidXNlcl9uZXdfcGFzc3dvcmQiLAoJCSJ0eXBlIjogIm5ld3Bhc3N3b3JkIgoJCX0sCiAgICAgICAgewoJCSJrZXkiOiAidXNlcl9jb25maXJtX25ld19wYXNzd29yZCIsCgkJInR5cGUiOiAiY29uZmlybXBhc3N3b3JkIgoJCX0KCQldCgkJfQogICAgICAgIA==",
"retryCount": 1,
"options": 3,
"appOptions": 0,
"domainsToDetect": "",
"urLsToDetect": "",
"type": "PLUGIN",
"url": "https://github.com/login",
"name": "Github",
"applicationGUID": "6c9e917d-e4b0-44e6-83aa-6f01c6ea314f",
"error": "",
"newIcon": "https://storageportalwus.blob.core.windows.net/images/3500A8E873DC713670543A2E1B1CF646"
}
]
Example request with cURL
Replace placeholder values surrounded by { } with the actual values.
curl -u : -X POST https://{company-name}.helloid.com/api/v1/endusers/{user-guid}/credentials -H "Content-Type:application/json" -d
"
{
"ApplicationGUID": "",
"CredSetName": "Default",
"Credentials": [{
"Function": "UserName",
"Value": "Mike",
"UserEditAllowed": true
}, {
"Function": "Password",
"Value": "g!sg*Z_x5",
"UserEditAllowed": true
}]
}
"