milestonexprotectwspython.xpwlogininfo

Module: xpwlogininfo.py

Revision History

Date Version Description
2023/07/11 1.0.0.0 Initial Version.

@export
class XPWLoginInfo:

Login information returned by a successful call to the LoginBasicUser or LoginWindowsUser call.

Threadsafety:

This class is fully thread-safe.

XPWLoginInfo()

Initializes a new instance of the class.

Type of user credentials used (e.g. Basic, Windows, etc) in the authentication process.

Returns:

The AuthenticationType property value.

ExpireTime: datetime.datetime

Date and Time (UTC) at which the security token willl expire.

Returns:

The ExpireTime property value.

This value is calculated by adding the TimeToLive property value to the RegistrationTime property value.

Password: str

Security password which is used in subsequent calls to the REST server for authentication.

Returns:

The Password property value.

RegistrationTime: datetime.datetime

Time at which the security token was registered, in UTC format.

Returns:

The RegistrationTime property value.

Scope: str

Security Scope which the token is to be used for (e.g. "managementserver", etc).

Returns:

The Scope property value.

TimeToLiveLimited: bool

TimeToLive calculated using time profile from APPLICATIONACCESSCLIENTLOGIN attribute.

Returns:

The TimeToLiveLimited property value.

TimeToLiveMilliseconds: int

Remaining time (in milliseconds) to live for the security token.

Returns:

The TimeToLiveSeconds property value, converted to milliseconds.

TimeToLiveSeconds: int

Remaining time (in seconds) to live for the security token.

Returns:

The TimeToLiveSeconds property value.

Token: str

Security token which is used in subsequent calls to the REST server for authentication.

Returns:

The Token property value.

TokenType: str

Security Token Type (e.g. "Bearer", etc).

Returns:

The TokenType property value.

UserName: str

Security username which is used in subsequent calls to the REST server for authentication.

Returns:

The UserName property value.