This API endpoint allows you to fetch the list of users in the pending enrollment status i.e. the users whose enrollment is yet to start.
Headers
- Authentication: Bearer <JWT>
- Accept: application/json
- Content-Type: application/json
Path Parameters
Parameters | Type | Description |
---|---|---|
organizationName | string | Denotes the name of the organization. |
groupID | string | The unique group ID of the group. |
sort | string | Sort the listed records based on the columns Requested For and Request Date.
|
order | string | The order of the displayed list. Possible Values:
|
page | string | Page number of the results to fetch. |
size | string | To set the maximum number of records to return in a paged list response. |
startDate | string | Start date of the date range to fetch user records. |
endDate | string | End date of the date range to fetch user records. |
Response Object
Parameter | Type | Description |
---|---|---|
content | array | An array containing user objects. |
id | integer | The unique ID of the user. |
firstName | string | The first name of the user. |
lastName | string | The last name of the user. |
string | The email address of the user. | |
createdDate | string | The date when the user was created. |
isFederated | boolean | Indicates if the user is federated. |
groupName | string | The name of the group to which the user belongs. |
groupId | string | The unique ID of the group to which the user belongs. |
identityTypeName | string | The type of identity associated with the user. |
enabled | boolean | Indicates if the user is enabled. |
username | string | The username of the user. |
credentials | string | The credentials associated with the user. |
enrolledBy | string | The entity that enrolled the user. |
totalElements | string | The total number of elements in the response. |
last | boolean | Indicates if this is the last page of results. |
totalPages | string | The total number of pages of results. |
size | string | The number of elements per page. |
number | string | The current page number. |
sort | string | The sorting criteria for the results. |
first | boolean | Indicates if this is the first page of results. |
numberOfElements | number | The number of elements in the current page. |