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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	sessionID: 0,
	hostName: String,
	ipAddress: String,
	expirationTime: "0001-01-01T00:00:00.000Z",
	identityProviderID: 0,
	restrictToSiteID: 0,
	protectionLevel: 0,
	requireConfirmation: False,
	isOneShot: False,
	userAgent: 
	{
		name: String,
		deviceName: String,
		deviceType: 0,
		osType: 0,
		osVersion: String,
		browserName: String,
		browserVersion: String
	}
}