api_auth

<back to all web services

SessionsRequest

The following routes are available for this service:
GET/api/sessionsInformation about all active sessions, site authorizations and application autorizations, for current logged-in user.
SessionsResponse Parameters:
NameParameterData TypeRequiredDescription
SessionsformSessionInfo[]NoUser's sessions. Includes site authorizations.
AppAuthorizationsformAppAutorizationInfo[]NoApplication authorizations granted by current user
SessionInfo Parameters:
NameParameterData TypeRequiredDescription
SessionIDformlongNo
HostNameformstringNo
IpAddressformstringNo
CreationTimeformDateTimeNo
ExpirationTimeformDateTime?No
IdentityProviderIDformshortNo
RestrictToSiteIDformlong?No
ProtectionLevelformshortNo
RequireConfirmationformboolNo
IsOneShotformboolNo
UserAgentformUserAgentInfoNo
SiteAuthorizationsformIEnumerable<SiteAutorizationInfo>No
UserAgentInfo Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
DeviceNameformstringNo
DeviceTypeformshortNo
OSTypeformshortNo
OSVersionformstringNo
BrowserNameformstringNo
BrowserVersionformstringNo
SiteAutorizationInfo Parameters:
NameParameterData TypeRequiredDescription
SiteNameformstringNo
SiteDomainformstringNo
AuthorizationIDformlongNo
CreationTimeformDateTimeNo
ExpirationTimeformDateTime?No
ScopeIDformshortNo
AppAutorizationInfo Parameters:
NameParameterData TypeRequiredDescription
AppHardwareNameformstringNo
AppUserNameformstringNo
AuthorizationIDformlongNo
CreationTimeformDateTimeNo
ExpirationTimeformDateTime?No
ScopeIDformshortNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/sessions HTTP/1.1 
Host: 1.hyper.id 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SessionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bitpub.Api.Auth.Common">
  <AppAuthorizations>
    <AppAutorizationInfo>
      <AppHardwareName>String</AppHardwareName>
      <AppUserName>String</AppUserName>
      <AuthorizationID>0</AuthorizationID>
      <CreationTime>0001-01-01T00:00:00</CreationTime>
      <ExpirationTime>0001-01-01T00:00:00</ExpirationTime>
      <ScopeID>0</ScopeID>
    </AppAutorizationInfo>
  </AppAuthorizations>
  <Sessions>
    <SessionInfo>
      <CreationTime>0001-01-01T00:00:00</CreationTime>
      <ExpirationTime>0001-01-01T00:00:00</ExpirationTime>
      <HostName>String</HostName>
      <IdentityProviderID>0</IdentityProviderID>
      <IpAddress>String</IpAddress>
      <IsOneShot>false</IsOneShot>
      <ProtectionLevel>0</ProtectionLevel>
      <RequireConfirmation>false</RequireConfirmation>
      <RestrictToSiteID>0</RestrictToSiteID>
      <SessionID>0</SessionID>
      <SiteAuthorizations i:nil="true" />
      <UserAgent>
        <BrowserName>String</BrowserName>
        <BrowserVersion>String</BrowserVersion>
        <DeviceName>String</DeviceName>
        <DeviceType>0</DeviceType>
        <Name>String</Name>
        <OSType>0</OSType>
        <OSVersion>String</OSVersion>
      </UserAgent>
    </SessionInfo>
  </Sessions>
</SessionsResponse>