UMApi (User, Tenant, Roles APIs)

getCurrentUser

Get the current login user.​

UMApi.getCurrentUser()

Parameters

None

Returns

dictionary

getCurrentUserId

Get the current user id​

UMApi.getCurrentUserId()

Parameters

None​

Returns

String

getIdOfCurrentUser

Get the current user id as a number​

UMApi.getIdOfCurrentUser()

Parameters

None​

Returns

String

getIdOfCurrentUserAsLong

Get the current user id as a long number.​

UMApi.getIdOfCurrentUserAsLong()

Parameters

None​

Returns

int

isNumeric

Check if i string number is numeric.​

UMApi.isNumeric(strNum)

Parameters

strNum: number (string)

Returns

result as a boolean

switchToPrivilegedMode

The privileged mode has a superuser access and is able to override logged in user to perform an internal workbench operation e.g., database access.​

UMApi.switchToPrivilegedMode()

Parameters

none​

Returns

none​

resetPrivilegedMode

Remove the privileged mode ​ thereby restoring everything to normal.

UMApi.resetPrivilegedMode()

Parameters

none​

Returns

none​

isPrivilegedMode

Check if privileged mode is active.

UMApi.isPrivilegedMode()

Parameters

none​

Returns

result as a boolean​

switchToPrivilegedUserMode

Switch into the privileged user mode.​

UMApi.switchToPrivilegedUserMode()

Parameters

none​

Returns

none​

resetPrivilegedUserMode

Reset the privileged user mode.

UMApi.resetPrivilegedUserMode()

Parameters

none

Returns

none

isPrivilegedUserMode

Check if privileged user mode is active

UMApi.isPrivilegedUserMode()

Parameters

none​

Returns

boolean status​

getCurrentUserTenantId

get current user tenantid

UMApi.getCurrentUserTenantId()

Parameters

none​

Returns

int

getTenantId

get tenantid

UMApi.getTenantId()

Parameters

none​

Returns

String

getUserByUserId

get user by userid

UMApi.getUserByUserId(userId)

Parameters

userId (string)

Returns

Object

getUser

get user using id

UMApi.getUser(id)

Parameters

id (string)

Returns

Object