blpapi.Identity#

class blpapi.Identity(handle, parentSession=None)#

Provides access to the entitlements for a specific user.

An unauthorized Identity is created using createIdentity(). Once an Identity has been created it can be authorized using sendAuthorizationRequest(). The authorized Identity can then be queried or used in subscribe() or sendRequest() calls.

Once authorized, an Identity has access to the entitlements of the user which it was validated for.

Identity objects are always created by the API, never directly by the application.

The class attributes are aliases of the SeatType members. New code should use SeatType.

BPS = 0#: Bloomberg Professional Service

INVALID_SEAT = -1#: Unknown seat type

NONBPS = 1#: Non-BPS

destroy()#

Destroy the handle using stored dtor

Return type:: None

getFailedEntitlements(service, entitlements)#

Parameters:

service – Service to check authorization for
entitlements – EIDs to check authorization for

Returns:

Tuple where the boolean is True if this Identity is authorized for the specified service and all of the specified entitlements, and the list is a subset of entitlements for which this Identity is not authorized.

Note

The contents of the returned list are not specified if this identity is not authorized for service.

getSeatType()#

Return type:: SeatType
Returns:: Seat type of this identity.

hasEntitlements(service, entitlements)#

Parameters:

service – Service to check authorization for
entitlements – EIDs to check authorization for

Returns:

True if this Identity is authorized for the specified service and for each of the entitlement IDs contained in the specified entitlements.

If Element is supplied for entitlements, it must be an array of integers.

isAuthorized(service)#

Parameters:: service – Service to check authorization for
Returns:: True if this Identity is authorized for the specified service, False otherwise.

isValid()#

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

Return type:: bool