GET /v1/users
Get a paginated list of users.
Parameters:
| Property | Data Type | Description |
|---|---|---|
| page | Integer | Page to start from. |
| limit | Integer | The number of records per page. |
| q | String | Search string or URL encoded JSON. |
| qType | String | Type of search. One of:
|
| qOperator | String | Applicable only if qType equals 'partial'. One of:
|
| sort | Object | Map of fields and sort order. { "field1": "asc", "field2": "desc" } Example: ?sort[field1]=asc&sort[field2]=desc |
Request Body: None
Request Example:
curl -X GET -H 'Authorization: Bearer <ACCESS_TOKEN>' -H 'Content-Type: application/json' 'https://api.perimeter81.com/api/rest/v1/users?page=1&limit=25&q=<SEARCH_WORD>&qType=full'Response Body:
Status Code | Message/Response Body | Description |
|---|---|---|
200 | Success. A list of users is returned. |
Response Example (200):
{
"data":[
{
"tenantId":"<TENANT_ID>",
"terminated":false,
"initialsColor":"#6BB9D7",
"invitationAttempts":0,
"invitationToken":"<INVITATION_TOKEN>",
"role":"<ROLE>",
"username":"<EMAIL>",
"email":"<EMAIL>",
"emailVerified":true,
"idProviders":{
"okta":{
"enrolledMfa":[
"guardian"
],
"idpConnName":"<IDP_CONNECTION>",
"groups":[
""
],
"userId":"<IDP_UserID>"
}
},
"firstName":"<FIRST_NAME>",
"lastName":"<LAST_NAME>",
"initials":"<INITIALS>",
"inviteMessage":"",
"icon":{
"__type":"File",
"name":"777e56502bc6197feea083e086fdf3a6aebd1ae17c727b33d7e2041fa6ad291e_avatar_JrazjjjLaz_1586071344318.png",
"url":"https://static.perimeter81.com/api/files/777e56502bc6197feea083e086fdf3a6aebd1ae17c727b33d7e2041fa6ad291e_avatar_JrazjjjLaz_1586071344318.png"
},
"roleName":"Engineering",
"lastVPNSuccessLoginAt":"2021-04-06T06:28:06.093Z",
"score":3.0999999999999996,
"createdAt":"2020-03-04T09:17:47.500Z",
"updatedAt":"2021-09-29T08:09:45.392Z",
"id":"JrazjLjLaz"
}
],
"page":1,
"totalPage":148,
"itemsTotal":148
}