GetCurrentUser

FRAMES NO FRAMES

Overview

Package

Deprecated

Help

API Reference for EPL (ApamaDoc) 10.5.4.1

SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION

DETAIL: IMPORT | CONSTANT | MEMBER | ACTION

com.apama.cumulocity
Event GetCurrentUser

Get user details. Set authorization, for basic authentication, or authCookie and xsrfToken, for oauth authentication to get user details of a different user. If neither is specified, will fetch details of current user.

Returns GetCurrentUserResponse event, if user details are fetched successfully, else returns GetCurrentUserResponseFailed event.

Send this to GetCurrentUser.SEND_CHANNEL to get details of required user

Since:: 10.5.2.0

See Also:: com.apama.cumulocity.GetCurrentUserResponse -; com.apama.cumulocity.GetCurrentUserResponseFailed -

Constant summary
`string`	`SEND_CHANNEL := "CumulocityIoTGenericChain"` Channel to send GetCurrentUser to.

Member summary
`integer`	`reqId` Request identifier. Must be generated using com.apama.cumulocity.Util.generateReqId().
`string`	`authorization` Authorization header of other user. Used for basic authentication.
`string`	`authCookie` OAuth authorization cookie of other user. Both authCookie and xsrfToken must be provided for OAuth authentication. If either is absent, will fetch details of current user.
`string`	`xsrfToken` OAuth xsrfToken of other user. Both authCookie and xsrfToken must be provided for OAuth authentication. If either is absent, will fetch details of current user.

Constant detail

SEND_CHANNEL

string SEND_CHANNEL := "CumulocityIoTGenericChain"

Channel to send GetCurrentUser to.

Since:: 10.5.2.0

Member detail

authCookie

string authCookie

OAuth authorization cookie of other user. Both authCookie and xsrfToken must be provided for OAuth authentication. If either is absent, will fetch details of current user.

authorization

string authorization

Authorization header of other user. Used for basic authentication.

reqId

integer reqId

Request identifier. Must be generated using com.apama.cumulocity.Util.generateReqId().

xsrfToken

string xsrfToken

OAuth xsrfToken of other user. Both authCookie and xsrfToken must be provided for OAuth authentication. If either is absent, will fetch details of current user.