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

{
	sessions: 
	[
		{
			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
			}
		}
	],
	appAuthorizations: 
	[
		{
			appHardwareName: String,
			appUserName: String,
			authorizationID: 0,
			expirationTime: "0001-01-01T00:00:00.000Z",
			scopeID: 0
		}
	]
}