ReadSessionProperties Operation

Description: The ReadSessionProperties operation enables you to read the session properties.

Service: Authentication Service (On-Premises Only)

Style: Document/literal wrapped

Input:

Message: ReadSessionProperties

Elements:  None

Output:

Message: ReadSessionPropertiesResponse

Output: Elements from the following list:

Element

Type

Description

IsValid

boolean

Indicates whether the session is valid

UserObjectId

int

The unique identifier of the user associated with the session.

UserName

String

The user's login name.

DatabaseInstanceId

int

The unique identifier of the database instance that this session is logged into.

DatabaseEncoding

string

The method  used to encode data in the database.

DatabaseName

string

The database name that this session is logged into.

DatabaseType

DatabaseTypeType string

The database type associated with the connection.  Currently restricted to the following values:

  • Oracle
  • SQL Server

DatabaseUrl

string

The Universal Resource Locator (URL) associated with the connection.

IgnoreNullComplexFields

boolean

Ignores any complex fields that have null field values. Complex fields are fields that have a structure that includes child elements.  An example of a complex field is the StandardWorkWeek field that is used in the Calendar service.

The default value of IgnoreNullComplexFields is true.



Legal Notices | Your Privacy Rights
Copyright © 2008, 2023

Last Published Wednesday, February 1, 2023