v4

latestSwagger 2.02026-08-0343714211.7 MB
user_security_events
User Security Events

List User Security Events

List User Security Events

get/user_security_events

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are created_at and user_id.

If set, return records where the specified field is equal to the supplied value. Valid fields are created_at and user_id. Valid field combinations are [ user_id, created_at ].

If set, return records where the specified field is greater than the supplied value. Valid fields are created_at.

If set, return records where the specified field is greater than or equal the supplied value. Valid fields are created_at.

If set, return records where the specified field is less than the supplied value. Valid fields are created_at.

If set, return records where the specified field is less than or equal the supplied value. Valid fields are created_at.

Response

A list of UserSecurityEvents objects.

idinteger

Event ID

event_type'lockout'

Type of user security event being recorded.

bodystring

Event body.

event_errorsstring[]

Event errors.

created_atstring date-time

Event create date/time.

body_urlstring

Link to log file.

user_idinteger

User ID.

Example response

[
  {
    "id": 1,
    "event_type": "example",
    "body": "example",
    "event_errors": [
      "example"
    ],
    "created_at": "2000-01-01T01:00:00Z",
    "body_url": "example",
    "user_id": 1
  }
]