The create credential set operation will create a new credential set or replace the current with the specified request body.
Request
Request URI
| Method | Request URI |
|---|---|
| POST | https://{company-name}.helloid.com/api/v1/credentialset/{username}/{applicationName} |
| POST | https://{company-name}.helloid.com/api/v1/credentialset/{userGuid}/{applicationName} |
| POST | https://{company-name}.helloid.com/api/v1/credentialset/{adsid}/{applicationName} |
| POST | https://{company-name}.helloid.com/api/v1/credentialset/{userId}/{applicationName} |
| POST | https://{company-name}.helloid.com/api/v1/credentialset/{username}/{applicationGuid} |
| POST | https://{company-name}.helloid.com/api/v1/credentialset/{userGuid}/{applicationGuid} |
| POST | https://{company-name}.helloid.com/api/v1/credentialset/{adsid}/{applicationGuid} |
| POST | https://{company-name}.helloid.com/api/v1/credentialset/{userId}/{applicationGuid} |
| POST | https://{company-name}.helloid.com/api/v1/credentialset/{username}/{applicationId} |
| POST | https://{company-name}.helloid.com/api/v1/credentialset/{userGuid}/{applicationId} |
| POST | https://{company-name}.helloid.com/api/v1/credentialset/{adsid}/{applicationId} |
| POST | https://{company-name}.helloid.com/api/v1/credentialset/{userId}/{applicationId} |
The new set will always replace the current set (if there is one).
Request parameters
| Parameter | Description |
|---|---|
| {company-name} | The company name of the target company |
| {username} | The user name of the target user |
| {userGuid} | The guid of the target user |
| {adsid} | The AD SID of the target user |
| {userId} | The id of the target user |
| {applicationName} | The name of the target application |
| {applicationGuid} | The guid of the target application |
| {applicationId} | The id of the target application |
Request headers
| Header | Description |
|---|---|
| Content-Type | Required. Must be set to application/json. |
Sample request body
{
"credentials" : [{"function":"username", "value": "j.doe"},{"function":"password", "value": "XpNYLUEGcar[Hh+e"}]
}
Request body parameters
| Parameter | Description | Required/Optional | Default value |
|---|---|---|---|
| {credentials} | List of credentials, if it is empty it will create an empty set. | Optional | Empty list |
| {function} | Function of the credential (like username or password) | Required | - |
| {value} | Value for the new credential | Required | - |
Functions
Each application could require there own function needed for their credentials. the most common are username, password and nameid (for SAML applications).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. |
Please also see error result.
Please also see common HTTP status codes.
Sample response body
None.
Example request with cURL
Replace placeholder values surrounded by { } with the actual values.
curl -u {api-key}:{api-secret} -X GET https://{company-name}.helloid.com/api/v1/credentialset/{username}/{applicationName} -H "Content-Type:application/json" -d
"{
'credentials': [{'function':"username', 'value': 'j.doe'},{'function':'password', 'value': 'XpNYLUEGcar[Hh+e'}]
}"