REST API Reference Version 4.4.0.0Search

Read

GET v1/tokens

Query parameters

Parameter Type
startRow NsUnsignedLong
endRow NsUnsignedLong
sortBy NsString
iSortBy NsString
pageSize NsUnsignedInt
id NsObjectID
session_token NsToken
username NsDomainUser
app_name NsAppName
source_ip NsIPAddress
creation_time NsTime
last_modified NsTime

GET v1/tokens/detail

Query parameters

Parameter Type
startRow NsUnsignedLong
endRow NsUnsignedLong
sortBy NsString
iSortBy NsString
fields NsCommaSeparatedList
pageSize NsUnsignedInt
id NsObjectID
session_token NsToken
username NsDomainUser
app_name NsAppName
source_ip NsIPAddress
creation_time NsTime
last_modified NsTime

GET v1/tokens/id

Query parameters

Parameter Type
fields NsCommaSeparatedList

Description

List user session tokens.

Normal Response Codes

200 206

HTTP Error Codes

400 401 403 404 500 503

Response

Parameter Type JSON Type Description Deprecated
id NsObjectID string Object identifier for the session token. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.  
session_token NsToken string Token used for authentication. String of 31 or 32 alphanumeric characters. Example: '9f53a789f1e9eae7b9385f4d8873fb1'.  
username NsDomainUser string User name for the session. Active Directory username. String up to 104 printable characters. Example: 'joe-91'.  
app_name NsAppName string Application name. String of 0-255 printable ASCII characters. Example: 'GUI'.  
source_ip NsIPAddress string IP address from which the session originates. Four numbers in the range [0,255] separated by periods. Example: '128.0.0.1'.  
creation_time NsTime number Time when this token was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.  
last_modified NsTime number Time when this token was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.  

JSON Response

            

{
   "data" : {
      "app_name" : "",
      "session_token" : "814728a4474d0d99508074c1ca8b94a9",
      "last_modified" : 1426776061,
      "id" : "1900000000000004d3000000000000000000000002",
      "creation_time" : 1426776061,
      "username" : "admin",
      "source_ip" : "127.0.0.1"
   }
}