Retrieve user sign-in history

Prev Next
Get
/SearchSignInHistory

Allows you to search for user sign in dates and times.

Security
API Key
Header parameter nameapi_key
Query parameters
pageIndex
integer (int32)

A 0-based index of the paged results you wish to receive. In general, you should start with a value of zero and increment it as you need to retrieve additional results. If not supplied, a value of 0 is used (the first page of results).

pageSize
integer (int32)

Indicates how many results you want per page. if not supplied, a default value of 100 is used.

sort
string

The value you want to sort by. If not supplied, a default value of "SignIn DESC" will be assumed. You can append "DESC" after the sort value to sort descending. For example, "SignIn DESC" would sort by sign-in time in descending order. Possible values: - SignIn - LastName - FirstName - UserName - Email

userId
integer (int32)

An optional parameter used to filter for sign-ins for a particular user.

userExternalId
string

An optional parameter used to filter for sign-ins for a particular user using an external identifier.

after
string

An optional parameter used to filter for sign-ins that occured after a specified date. When used in conjunction with the "before" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.

before
string

An optional parameter used to filter for sign-ins that occured before a specified date. When used in conjunction with the "after" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.

Responses
200

OK Response

Expand All
object
Status
integer (int32)

Indicates the status of the API request.

0 = Success
10 = Error
20 = Not found
30 = Invalid integration key

Example10
Error
string | null

Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).

TotalCount
integer (int32)

The total number of results that match the search conditions, not all of which may be in the current result set.

Example1
TotalPages
integer (int32)

The total number of result pages that match the search conditions.

Example1
Results
Array of object (SignInHistorySearchResult)

See SignInHistorySearchResult.

object
UserId
integer (int32)

The user's unique identifier

Example190615
UserExternalId
string | null

The user's external ID, usually a unique identifier from the calling system

Example5A875994-33DE-DE11-92BB-00505690582E
FirstName
string

The user's first name

ExampleJohn
LastName
string

The user's last name

ExampleDoe
UserName
string

The user's UserName (used during sign-in)

Examplejohn.doe
Email
string

The user's e-mail address

Examplejohn.doe@sample.net
OrganizationId
integer (int32)

The unique identifier of the organization the user belongs to

Example2471
SignIn
integer (int64)

When the user sign-in occurred (in Unix epoch time)

Example1466117145
Method
string

The method that was used to authenticate the user with possible values of:

  • Unknown
  • Local Account
  • Authentication Provider
  • API
ExampleLocal Account
Provider
string | null

The name of the Authentication Provider when the "Method" field is "Authentication Provider".