Get Session Data
get
/api/core/Login/readSessionInfo
Gets the session data.
Request
There are no request parameters for this operation.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
The session data.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : SessionInfoRead
Type:
Show Source
object
-
EmailAddress: string
Email AddressExample:
example.email.com
-
FullName: string
The full name of the user.Example:
Example Name
-
Locale: string
Defines the specific regional and language preferencesExample:
en_US
-
PasswordExpiration: integer
Duration in which password will get expired in seconds from epoch timeExample:
2147483647
-
PermissionIDs: object
PermissionIDs
An object having ids of all the permissions that the user has
-
Permissions: object
Permissions
An object having sub-objects each of which shows permissions like create, update, delete available to the user for each endpoint
-
Preferences: object
Preferences
An object showing the user preferences
-
Properties: object
Properties
An object showing restrictive property IDs
-
SamlUser: boolean
Whether the User is a Saml UserExample:
false
-
SupportPassword: string
Support PasswordExample:
example password
-
SupportUsername: string
Support UsernameExample:
example username
-
ThemeDir: string
Theme selected by the userExample:
light
-
TZ: string
Time Zone represented in an abbreviated format also depicting offset from UTC.Example:
CST6CDT
-
UserGroupID: integer
The user group ID.Example:
1
-
UserID: integer
The user ID.Example:
1001
-
Username: string
UsernameExample:
admin
Nested Schema : type
Type:
Show Source
object
-
BaseDir: string
The base directory.Example:
/bin/directory
Nested Schema : PermissionIDs
Type:
object
An object having ids of all the permissions that the user has
Example:
{
"AAAAuthTypes":"10021",
"brokerServices":"11008"
}
Nested Schema : Permissions
Type:
object
An object having sub-objects each of which shows permissions like create, update, delete available to the user for each endpoint
Example:
{
"AAA":{
"AuthTypes":{
"read":true,
"create":false
},
"Permissions":{
"read":true,
"create":false
}
}
}
Nested Schema : Preferences
Type:
object
An object showing the user preferences
Example:
{
"PageSize":"1000",
"RefreshRate":"60"
}
Nested Schema : Properties
Type:
object
An object showing restrictive property IDs
Example:
{
"RestrictiveDeviceGroupId":"1"
}
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object