blpapi.AuthUser

class blpapi.AuthUser(handle)

Contains user-specific authorization options.

classmethod createWithActiveDirectoryProperty(propertyName)

Creates an AuthUser instance configured for Active Directory authorization mode (DIRECTORY_SERVICE).

Parameters:

propertyName (str) – Active Directory property.

Return type:

AuthUser

Returns:

Configured for Active Directory (DIRECTORY_SERVICE) authorization mode.

The behavior is undefined when propertyName is "" or None.

classmethod createWithLogonName()

Creates an AuthUser instance configured for Operating System Login (Domain/User) authorization mode (OS_LOGON).

Return type:

AuthUser

Returns:

Configured for Operating System Login (Domain/User) mode.

classmethod createWithManualOptions(userId, ipAddress)

Creates an AuthUser instance configured for manual authorization.

Parameters:

• userId (str) – user id.

• ipAddress (str) – IP address.

Return type:

AuthUser

Returns:

Configured for manual authorization.

The behavior is undefined when either userId or ipAddress is "" or None.

destroy()

Destroy the handle using stored dtor

Return type:

None

isValid()

Returns: True if this class holds a handle and the handle is not None.

Return type:

bool