HomeGuidesAPI Reference
API Reference

Get usernames and roles for given IP and time range

Retrieves a list of usernames and roles from ClearPass event logs for a specified IP address within a time range. When type is 'flow', filters events where the flow falls within the time range; otherwise returns events that started within the range.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

The IP address to query for associated usernames and roles. Must be a valid IPv4 address.

string
enum

Query type for filtering events. Use 'flow' to filter events where the flow time falls within the range (start_time <= startTime AND end_time >= endTime). Default behavior returns events that started within the range.

Allowed:
int64
required

Start of the time range as epoch timestamp in milliseconds. Events are filtered based on this value.

int64
required

End of the time range as epoch timestamp in milliseconds. Must be greater than or equal to startTime.

Responses

401

Unauthorized - Authentication required or invalid credentials.

403

Forbidden - User lacks READ or READ_WRITE permissions.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json