POST api/Admin/UserSessions/Search

Searches the user sessions based on the specified criteria.

Request Information

URI Parameters

None.

Body Parameters

ESignSystems.Security.Services.UserSessionSearchCriteria

Name	Type	Additional information
UserName	string	None.
StartLoginDate	date	None.
EndLoginDate	date	None.
ApiClientId	string	None.
TokenRevoked	boolean	None.
PageSize	integer	None.
PageOffset	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "UserName": "sample string 1",
  "StartLoginDate": "2024-11-26T17:40:53.8758076-05:00",
  "EndLoginDate": "2024-11-26T17:40:53.8758076-05:00",
  "ApiClientId": "sample string 2",
  "TokenRevoked": true,
  "PageSize": 1,
  "PageOffset": 3
}

application/xml, text/xml

Sample:

<UserSessionSearchCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.Security.Services">
  <ApiClientId>sample string 2</ApiClientId>
  <EndLoginDate>2024-11-26T17:40:53.8758076-05:00</EndLoginDate>
  <PageOffset>3</PageOffset>
  <PageSize>1</PageSize>
  <StartLoginDate>2024-11-26T17:40:53.8758076-05:00</StartLoginDate>
  <TokenRevoked>true</TokenRevoked>
  <UserName>sample string 1</UserName>
</UserSessionSearchCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of user sessions.

Collection of ESignSystems.Security.Services.Data.Entities.UserSession

Name	Type	Additional information
UserSessionId	string	None.
UserName	string	Required Max length: 256
ApiClientId	string	Max length: 128
IpAddress	string	Required Max length: 50
LoginDate	date	Required
AuthenticationTicket	string	Max length: 2000
AccessToken	string	Max length: 2000
InviteCode	string	Max length: 60
RefreshToken	string	Max length: 256
TokenRefreshDate	date	None.
TokenRevoked	boolean	Required
TokenRevokedDate	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "UserSessionId": "sample string 1",
    "UserName": "sample string 2",
    "ApiClientId": "sample string 3",
    "IpAddress": "sample string 4",
    "LoginDate": "2024-11-26T17:40:53.8758076-05:00",
    "AuthenticationTicket": "sample string 6",
    "AccessToken": "sample string 7",
    "InviteCode": "sample string 8",
    "RefreshToken": "sample string 9",
    "TokenRefreshDate": "2024-11-26T17:40:53.8758076-05:00",
    "TokenRevoked": true,
    "TokenRevokedDate": "2024-11-26T17:40:53.8758076-05:00"
  },
  {
    "UserSessionId": "sample string 1",
    "UserName": "sample string 2",
    "ApiClientId": "sample string 3",
    "IpAddress": "sample string 4",
    "LoginDate": "2024-11-26T17:40:53.8758076-05:00",
    "AuthenticationTicket": "sample string 6",
    "AccessToken": "sample string 7",
    "InviteCode": "sample string 8",
    "RefreshToken": "sample string 9",
    "TokenRefreshDate": "2024-11-26T17:40:53.8758076-05:00",
    "TokenRevoked": true,
    "TokenRevokedDate": "2024-11-26T17:40:53.8758076-05:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfUserSession xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.Security.Services.Data.Entities">
  <UserSession>
    <AccessToken>sample string 7</AccessToken>
    <ApiClientId>sample string 3</ApiClientId>
    <AuthenticationTicket>sample string 6</AuthenticationTicket>
    <InviteCode>sample string 8</InviteCode>
    <IpAddress>sample string 4</IpAddress>
    <LoginDate>2024-11-26T17:40:53.8758076-05:00</LoginDate>
    <RefreshToken>sample string 9</RefreshToken>
    <TokenRefreshDate>2024-11-26T17:40:53.8758076-05:00</TokenRefreshDate>
    <TokenRevoked>true</TokenRevoked>
    <TokenRevokedDate>2024-11-26T17:40:53.8758076-05:00</TokenRevokedDate>
    <UserName>sample string 2</UserName>
    <UserSessionId>sample string 1</UserSessionId>
  </UserSession>
  <UserSession>
    <AccessToken>sample string 7</AccessToken>
    <ApiClientId>sample string 3</ApiClientId>
    <AuthenticationTicket>sample string 6</AuthenticationTicket>
    <InviteCode>sample string 8</InviteCode>
    <IpAddress>sample string 4</IpAddress>
    <LoginDate>2024-11-26T17:40:53.8758076-05:00</LoginDate>
    <RefreshToken>sample string 9</RefreshToken>
    <TokenRefreshDate>2024-11-26T17:40:53.8758076-05:00</TokenRefreshDate>
    <TokenRevoked>true</TokenRevoked>
    <TokenRevokedDate>2024-11-26T17:40:53.8758076-05:00</TokenRevokedDate>
    <UserName>sample string 2</UserName>
    <UserSessionId>sample string 1</UserSessionId>
  </UserSession>
</ArrayOfUserSession>