Skip to main content

Get sign-in activities

Description#

Retrieve a list of sign-in activities by a specified user.

Request#

HTTP Method: GET

Query ParameterDescription
N/A
Path ParameterDescription
user-idID of the user.
curl -X GET \  https://<tenant-domain>/api/v1/admin/users/<user-id>/signin_activities \  -H 'content-type: application/json' \  -H 'x-user-email: <email-address' \  -H 'x-user-token: <api-token>'

Response#

A successful request will return a JSON Array describing login events by the specified user.

Field description#

ParameterDescription
idSignin Activity ID.
identityEmail associated with the user.
successBoolean representing success or failure on login.
failure_reasonReason for login failure if available.
referrerURL that that the user logged in from.
cityCity where the login occurred.
regionRegion/State/Providence where the login occurred.
countryCountry where the login occurred.

Sample response#

[  {    "id": 15,    "scope": "user",    "strategy": "database_authenticatable",    "identity": "user@tines.io",    "success": true,    "failure_reason": null,    "user_type": "User",    "user_id": 1,    "context": "sessions#create",    "ip": "::1",    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/76.0.3809.100 Safari/537.36",    "referrer": "https://<tenant-domain>/users/sign_in",    "city": null,    "region": null,    "country": null,    "created_at": "2019-08-21T08:45:57.596Z"  }]