blpapi.AuthOptions

class blpapi.AuthOptions

Defines the authorization options which the user can set on SessionOptions as the authorization options for the session identity or use to authorize other identities.

classmethod createWithApp(appName)

Create an AuthOptions instance for Application Mode.

Parameters

appName (str) – app name used for Application Mode.

Returns

Specifies Application Mode.

Return type

AuthOptions

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

classmethod createWithToken(token)

Create an AuthOptions instance for Manual Token Mode.

Parameters

token (str) – token to use for Manual Token Mode.

Returns

Specifies Manual Token Mode.

Return type

AuthOptions

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

classmethod createWithUser(user)

Creates an AuthOptions instance for User Mode with the Operating System Login (Domain/User), Active Directory, or Email.

Parameters

user (AuthUser) – user-specific authorization option.

Returns

Specifies User Mode with the Operating System Login (Domain/User), Active Directory, or Email.

Return type

AuthOptions

The behavior is undefined when user was created with AuthUser.createWithManualOptions() or is None.

classmethod createWithUserAndApp(user, appName)

Create an AuthOptions instance for User and Application Mode.

Parameters

• user (AuthUser) – user-specific authorization option.

• appName (str) – app name used for Application Mode.

Returns

an AuthOptions that contains the authorization option for the User+Application authorization mode.

Return type

AuthOptions

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

destroy()

Destroy this AuthOptions.