Endpoint
/api/v2/tenants/{tenantId}/users/loginHistory/search
Gets the login history details of users.
Notes
There are special characters that can be used in a query string:
- (+) represents the next field and must be URL-encoded.
- (:) represents equals. An example is
key : value
. - Space characters must be URL-encoded.
- Date format must be yyyy-MM-ddTHH:mm:ssZ (GMT).
Query Variables
Query Variables | Description |
---|---|
id | User ID. |
loginName | User login name. |
startLoginDate | Search for the users who logged in within a specific duration. startLoginDate denotes the from date. |
endLoginDate | Search for the users who logged in within a specific duration. endLoginDate denotes the to date. |
startLogoutDate | Search for the users who logged out within a specific duration. startLogoutDate denotes the from date. |
endLogoutDate | Search for the users who logged out within a specific duration. endLogoutDate denotes the to date. |
Path Parameters
tenantIdstring
Query Parameters
pageNointeger
pageSizeinteger
sortNamestring
isDescendingOrderboolean
queryStringstring
Responses
OK
descendingOrderboolean
nextPageboolean
nextPageNointeger
orderBystring
pageNointeger
pageSizeinteger
previousPageNointeger
resultsarray
Child Parameters
- results.client
- results.id
- results.loginTime
- results.loginType
- results.logoutTime
- results.logoutType
- results.partner
- results.sessionId
- results.sourceHost
- results.sourceIp
- results.status
- results.user
totalPagesinteger
totalResultsinteger
{
"descendingOrder": true,
"nextPage": true,
"nextPageNo": 2,
"orderBy": "id",
"pageNo": 1,
"pageSize": 2,
"previousPageNo": 0,
"results": [
{
"client": {
"activated": true,
"id": 93,
"name": "Brocade Lab",
"uniqueId": "client_93"
},
"id": 12716,
"loginTime": "2016-01-28T07:58:54+0000",
"loginType": "Success",
"logoutTime": "2016-01-28T09:59:57+0000",
"logoutType": "Normal",
"partner": {
"activated": true,
"id": 92,
"name": "Brocade Inc",
"uniqueId": "msp_92"
},
"sessionId": "DD8288A5906A694C67C982ADF0E54750",
"sourceHost": "127.0.0.1",
"sourceIp": "127.0.0.1",
"status": "Logged Out",
"user": {
"changePassword": false,
"email": "John.Smith@organization.com",
"firstName": "John",
"id": "USR0000002114",
"lastName": "Smith",
"loginName": "John.Smith"
}
},
{
"client": {
"activated": true,
"id": 93,
"name": "Brocade Lab",
"uniqueId": "client_93"
},
"id": 12709,
"loginTime": "2016-01-25T07:01:11+0000",
"loginType": "Success",
"logoutTime": "2016-01-25T07:01:31+0000",
"logoutType": "Normal",
"partner": {
"activated": true,
"id": 92,
"name": "Brocade Inc",
"uniqueId": "msp_92"
},
"sessionId": "1BC85D994F8B2919A24BCE82D61D8AEB",
"sourceHost": "127.0.0.1",
"sourceIp": "127.0.0.1",
"status": "Logged Out",
"user": {
"changePassword": false,
"email": "james.scott@organization.com",
"firstName": "James",
"id": "USR0000002114",
"lastName": "Scott",
"loginName": "James.Scott"
}
}
],
"totalPages": 47,
"totalResults": 94
}