The user enrollment operation will retrieve either a list of applications in which a given user is enrolled, or a list of users who are enrolled in a given application.
Request
Request URI
| Method | Request URI |
|---|---|
| GET | https://{company-name}.helloid.com/api/v1/users/{username}/enrollment |
| GET | https://{company-name}.helloid.com/api/v1/users/{userGuid}/enrollment |
| GET | https://{company-name}.helloid.com/api/v1/applications/{applicationName}/enrollment |
| GET | https://{company-name}.helloid.com/api/v1/applications/{applicationGuid}/enrollment |
Request parameters
| Parameter | Description |
|---|---|
| {company-name} | The company name of the target company |
| {username} | The user name of the user to retrieve the enrollment for |
| {userGuid} | The user guid of the user you want to retrieve the enrollment for |
| {applicationGuid} | The Guid of the application your want to retrieve the enrollment for |
| {applicationName} | The name of the application your want to retrieve the enrollment for |
Request headers
| Header | Description |
|---|---|
| Content-Type | Required. Must be set to application/json. |
Request body
None.
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
{
"applications": [
{
"name": "Facebook",
"icon": null,
"url": "https://www.facebook.com/login.php",
"helloIDUrl": "https://websso.portal.dev/relayservice/redirect/4ea4eb90-e222-4feb-8cf7-380c436b659d",
"isEnabled": true,
"type": "PLUGIN",
"description": null,
"applicationGUID": "4ea4eb90-e222-4feb-8cf7-380c436b659d",
"creationTime": "2016-06-15T13:10:25.06",
"modifyTime": "2016-06-15T13:10:25.06",
"modifyUser": "GeorgeBakker"
},
{
"name": "LinkedIn",
"icon": null,
"url": "https://www.linkedin.com/uas/login",
"helloIDUrl": "https://websso.portal.dev/relayservice/redirect/2c2d713e-bacb-443d-8e9a-5483fab3a420",
"isEnabled": true,
"type": "PLUGIN",
"description": null,
"applicationGUID": "2c2d713e-bacb-443d-8e9a-5483fab3a420",
"creationTime": "2016-01-13T21:14:18.557",
"modifyTime": "2016-01-13T21:16:01.92",
"modifyUser": "R.Brussaard"
}
],
"users": [
{
"userGUID": "dce1f330-c4e1-4bb6-953a-85267ca53f21",
"lastLogin": "2016-09-06T12:37:54.917",
"source": "Local",
"firstName": "John",
"lastName": "Doe",
"userName": "J.Doe",
"isEnabled": true,
"isLocked": false,
"mustChangePassword": false,
"lockTime": null,
"passwordLastSetTime": "2016-08-25T07:44:16.43",
"type": "Admin",
"adsid": null,
"contactEmail": "j.doe@email.com",
"userAttributes": {
"phoneNumber": "",
"language": "NL"
}
}
]
}
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/users/{username}/enrollment