The get all users operation will retrieve a list of all users from your company. You can filter with the enabled parameter if only enabled or disabled users are required.
Request
Request URI
| Method | Request URI |
|---|---|
| GET | https://{company-name}.helloid.com/api/v1/users{?enabled={true or false}&take=x&skip=y&isDeleted={true or false (default)}} |
Request parameters
| Parameter | Description |
|---|---|
| {company-name} | The company name of the target company |
| {enabled} | Optional. With this parameter you can filter the result for only enabled users (?enabled=true) or disabled users (?enabled=false) |
| {take} | Optional. With this parameter you can specify the maximum number of users that should be returned. Default take is 100 users. |
| {skip} | Optional. With this parameter you can specify how many users should be skipped. |
| {isDeleted} | Optional. With this parameter you can filter the result for deleted users (?isDeleted=true) or non deleted users (?isDeleted=false) Default isDeleted is false. |
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
[{
"id": 1,
"userGUID": "3216f4b1-c290-4b6f-8ddb-921889331f56",
"lastLogin": "2016-02-26T13:43:35.437",
"source": "AD",
"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"
}
}, {
"id": 2,
"userGUID": "c206d5da-0a36-4262-816e-2b9c9b6e41ff",
"lastLogin": "2016-02-26T13:43:35.437",
"source": "Local",
"links": [{
"title": "self",
"location": "/api/v1/users/c206d5da-0a36-4262-816e-2b9c9b6e41ff"
}, {
"title": "self",
"location": "/api/v1/users/J.Smith"
}, {
"title": "self",
"location": "/api/v1/users/2"
}, {
"title": "self",
"location": "/api/v1/users/S-1-5-21-000000000-0000000000-000000000-0001"
}, {
"title": "All users",
"location": "/api/v1/users/"
}],
"firstName": "John",
"lastName": "Smith",
"userName": "J.Smith",
"managedByUserGUID": null,
"isEnabled": true,
"isDeleted": false,
"isLocked": false,
"mustChangePassword": false,
"lockTime": null,
"passwordLastSetTime": null,
"roles": ["Administrator"],
"adsid": "S-1-5-21-000000000-0000000000-000000000-0001",
"contactEmail": "j.smith@email.com",
"userAttributes": {}
}]
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/