Skip to Content

mvSQL Runtime Function - WHO()

Who() Function Summary

Returns information about the logged in user.

Syntax

who(<parameter>)

Parameters

parameter

An optional parameter that determines which user attribute is returned. Valid parameters include:

  • 'appuserid' - The application-supplied user identity. See the Application Authentication security provider.
  • 'displayname' - The user's display name (John).
  • 'email' - Alias for 'emailaddress'.
  • 'emailaddress' - The user's email address (smith@example.com).
  • 'fullname' - The user's full name (John Smith).
  • 'identity.identifier' - The data source identity identifier (1234567).
  • 'identity.name' - The data source identity name (JOHN SMITH).
  • 'isauthenticated' - Returns true or false based on whether the user is authenticated.
  • 'language' - The user's configured language (en-US).
  • 'phone' - Alias for 'phonenumber'.
  • 'phonenumber' - The user's preferred phone number.
  • 'userid' - The unique identifier assigned to the user by Vinyl.
  • 'username' - The username of the logged in user (Ex. admin). This is the value returned if no parameter is specified.

Returns

string

See the parameter.

Remarks

If the parameter name is specified in all caps, the return string will be all caps.

Parameters beginning with 'identity' will return identity-specific information. The identity is determined based on the current data source. For instance, assume a rule is registered to a Salesforce data source. In this scenario, who('identity.identifier') will return the Salesforce identifier for that user.

Examples

who()

Returns:

admin

who('username')

Returns:

admin

who('USERNAME')

Returns:

ADMIN

who('isauthenticated')

Returns:

1 (or "true")