List identity risk events
This endpoint lists all identity risk events for an organization.
Example request:
GET /api/v2/identityrisk/events?filter=level:eq:RISK_LEVEL_MEDIUM&limit=10&skip=0&sort=-lastOccurrenceAt
Example request with multiple filters:
GET /api/v2/identityrisk/events?filter=level:eq:RISK_LEVEL_MEDIUM&filter=resolutionStatus:eq:RISK_RESOLUTION_STATUS_OPEN&limit=25&skip=0
Request
- Base URLhttps://console.jumpcloud.com
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
A filter to apply to the query.
Filter structure: <field>:<operator>:<value>.
field = A supported collection field name (camelCase): identityObjectId, identityType, identityIdentifier, score, occurrenceCount, level, resolutionStatus, resolutionState, firstOccurrenceAt, lastOccurrenceAt, loginResource, loginStatus, countryCode, city, riskFactorCode.
operator = Supported operators are: eq, ne, gt, ge, lt, le, search, in.
value = Populate with the value you want to search for. Is case sensitive. Supports wild cards.
Example GET /api/v2/identityrisk/events?filter=level:eq:RISK_LEVEL_MEDIUM Example for users GET /api/v2/identityrisk/events?filter=identityIdentifier:in:user1,user2 Example for score GET /api/v2/identityrisk/events?filter=score:gt:50
The fields on the items listed to return.
The offset into the records to return.
An optional comma separated field names used to sort the collection. Default sort is ascending, prefix with - to sort descending.
The number of records to return at once. If the number returned is less than limit there are no more records to fetch. If the number returned equals limit there may be more records. Increment skip by limit to get the next set.
A free-text search term matched against all string filter fields (case-insensitive substring) and object-id fields objectId and identityObjectId (exact hex match). A match on any field is sufficient (logical OR), and searchTerm is combined with filter using logical AND.
Example GET /api/v2/identityrisk/events?searchTerm=john.doe Combined with filters GET /api/v2/identityrisk/events?searchTerm=john&filter=resolutionStatus:eq:RISK_RESOLUTION_STATUS_OPEN
Response
A successful response.
Changes
No recorded changes to this operation across all 1 revision of this API.