Find users given a criteria. The criteria object can have multiple fields set in which case they are treated as an "AND".
object (UserCriteria) | |
object (PageRequest) |
OK
Bad Request. The request parameters (or body) were malformed or invalid. Fix the issues with the request and try again.
Unauthorized request. Make sure token was included and is valid and try again.
Forbidden. You are not permitted to access the requested resource.
{- "criteria": {
- "orgId": "string",
- "orgIds": [
- "string"
], - "enabled": true,
- "locked": true,
- "expired": true,
- "credentialsExpired": true,
- "usingMfa": true,
- "sharedSecret": "string",
- "lastName": "string",
- "firstName": "string",
- "roles": [
- "string"
], - "privileges": [
- "string"
], - "privilegeRoles": [
- "string"
], - "username": "string",
- "email": "string",
- "basic": "string",
- "authenticator": "string",
- "authenticators": [
- "string"
], - "authenticatorInclude": true,
- "startTimestamp": "2019-08-24T14:15:22Z",
- "endTimestamp": "2019-08-24T14:15:22Z"
}, - "pageRequest": {
- "pageNumber": 0,
- "pageSize": 0,
- "sort": [
- {
- "fieldName": "string",
- "sort": "ASC"
}
]
}
}
{- "totalCount": 0,
- "pageRequest": {
- "pageNumber": 0,
- "pageSize": 0,
- "sort": [
- {
- "fieldName": "string",
- "sort": "ASC"
}
]
}, - "items": [
- {
- "userKey": {
- "username": "string",
- "authenticator": "string"
}, - "password": "string",
- "orgId": "string",
- "email": "string",
- "enabled": true,
- "locked": true,
- "forcePasswordChange": false,
- "expired": true,
- "credentialsExpired": true,
- "usingMfa": true,
- "mfaSecret": "string",
- "sharedSecret": "string",
- "notes": "string",
- "createdInstant": "2019-08-24T14:15:22Z",
- "lastUpdatedInstant": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "lastUpdatedBy": "string",
- "lastName": "string",
- "firstName": "string",
- "primaryPhone": "string",
- "primaryPhoneCountryCode": "string",
- "primaryPhoneExtension": "string",
- "lastSuccessfulAuthAttempt": "2019-08-24T14:15:22Z",
- "lastFailedAuthAttempt": "2019-08-24T14:15:22Z",
- "timeZone": "string",
- "locale": "string",
- "roles": [ ],
- "privileges": [ ],
- "allRoles": [
- {
- "name": "string",
- "description": "string",
- "internal": false,
- "privileges": [
- {
- "name": "string",
- "description": "string"
}
]
}
], - "allPrivileges": [
- {
- "name": "string",
- "description": "string"
}
], - "id": "string",
- "isSsoUser": false
}
], - "totalPages": 0
}