api_auth

<back to all web services

SessionRequest

The following routes are available for this service:
GET/api/sessionInformation about specified session. Existing session with bit.pub is required to call this api.
SessionRequest Parameters:
NameParameterData TypeRequiredDescription
IDquerylongYesTarget session ID.
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

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/session HTTP/1.1 
Host: 1.hyper.id 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SessionInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bitpub.Api.Auth.Common">
  <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>