IAbstractSession.SendAuthorizationRequest Method (Request, Identity, IEventQueue, CorrelationID, String)

IAbstractSessionSendAuthorizationRequest Method (Request, Identity, IEventQueue, CorrelationID, String)

Authorizes an identity.

This request can be used by applications to authorize users to receive data from services. If a user is successfully authorized all the entitlements for that user are cached locally. Once authorized the identity can be used to make subscriptions and requests as the user.

If an IEventQueue is specified then all response events for this Authorization Request are published to this event queue. The user can block on this event queue for responses and can use this as a mechanism to convert this asynchronous request into a synchronous request.

An Event will be published containing a message with the result of the authorization request. If the user was successfully authorized an "AuthorizationSuccess" message will be generated. If the user was not authorized an "AuthorizationFailure" message will be generated.

Namespace: Bloomberglp.Blpapi
Assembly: Bloomberglp.Blpapi (in Bloomberglp.Blpapi.dll) Version: 3.18.1.1

Syntax

C++

Copy

CorrelationID SendAuthorizationRequest(
	Request request,
	Identity identity,
	IEventQueue eventQueue,
	CorrelationID correlationId,
	string requestLabel
)

Function SendAuthorizationRequest ( 
	request As Request,
	identity As Identity,
	eventQueue As IEventQueue,
	correlationId As CorrelationID,
	requestLabel As String
) As CorrelationID

CorrelationID^ SendAuthorizationRequest(
	Request^ request, 
	Identity^ identity, 
	IEventQueue^ eventQueue, 
	CorrelationID^ correlationId, 
	String^ requestLabel
)

abstract SendAuthorizationRequest : 
        request : Request * 
        identity : Identity * 
        eventQueue : IEventQueue * 
        correlationId : CorrelationID * 
        requestLabel : string -> CorrelationID

Parameters

request: Type: Bloomberglp.BlpapiRequest
A filled in authorization request that needs to be sent to the authorization service.
identity: Type: Bloomberglp.BlpapiIdentity
A handle to identify the user that is being authorized.
The Identity must have been created with this session and must not be the session identity.
eventQueue: Type: Bloomberglp.BlpapiIEventQueue
An event queue to be used to receive response events for this request.
correlationId: Type: Bloomberglp.BlpapiCorrelationID
A correlator to be used for correlating the response to this request.
Must not already be in use.
requestLabel: Type: SystemString
A label which will be recorded along with any diagnostics for this operation.

Return Value

Type: CorrelationID
The CorrelationID object that will identify Message objects generated as a result of this call. This will be correlationId if it was provided.

Reference

IAbstractSession Interface

SendAuthorizationRequest Overload

Bloomberglp.Blpapi Namespace