Skip to main content

Get log event

The endpoint provides detailed information of a log event.

HTTP request

GET https://$instanceId.id.nevis.cloud/nevis/api/v1/events/$eventId

Parameters

ParameterInTypeRequired / OptionalDescription
instanceIdpathstringrequiredThe ID of your Identity Cloud instance
eventIdpathstringrequiredThe ID of the event
Example request

Set the ID of the event.

eventId=your-event-id-123
curl "https://$instanceId.id.nevis.cloud/nevis/api/v1/events/$eventId" \
--header "Authorization: Bearer $accessKey"

HTTP response

On success

HTTP/1.1 200 is returned on success.

ParameterTypeDescription
eventIdstringThe ID of the event
namestringThe name of the event
descriptionstringThe description of the event
timestampstringThe timestamp of the event in ISO 8061 timestamp format YYYY-MM-DDThh:mm:ss.SSSZ
statusenumThe status of the event Values: succeeded, failed
actor.idstringThe ID of the event actor
actor.loginIdstringThe login ID of the event actor
actor.typestringThe type of the actor Values: admin, api, user
actor.userAgentstringThe user agent of the actor
<event-type-specific>objectThe additional event type specific information. See the list of events for additional information
Example response

{
"actor": {
"loginId": "[email protected]",
"userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36",
"id": "78f89c75-8223-4546-a8ac-0ff9f233c6ee",
"type": "admin"
},
"eventId": "4aab5eef-fdd3-11ec-8119-000d3aac87a0",
"name": "user.password.reset",
"description": "User password reset",
"user": {
"firstName": "Abigail",
"lastName": "Mackay",
"loginId": "[email protected]",
"id": "c3fe8690-46ab-427a-aeb4-91a506f903a9"
},
"timestamp": "2022-07-07T09:00:17.242Z",
"status": "succeeded"
}

On failure

HTTP/1.1 401 is returned if the authorization failed due to an invalid access key.

HTTP/1.1 404 is returned if no event is found with the given eventId.

HTTP/1.1 500 is returned if an unexpected error occurred.