blpapi.AuthUser

class blpapi.AuthUser

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.

Returns

Configured for Active Directory (DIRECTORY_SERVICE) authorization mode.

Return type

AuthUser

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).

Returns

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

Return type

AuthUser

classmethod createWithManualOptions(userId, ipAddress)

Creates an AuthUser instance configured for manual authorization.

Parameters

• userId (str) – user id.

• ipAddress (str) – IP address.

Returns

Configured for manual authorization.

Return type

AuthUser

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

destroy()

Destroy this AuthUser.