Skip to main content

The Current User object

Classic apps

You're viewing documentation for classic apps, which use Retool's original app editor. The new app builder is the recommended way to build apps and where Retool focuses new development.

Not available in public apps

current_user is null for publicly accessible classic apps that do not require authentication.

Properties​

All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

email​

The email address.

Type string
Format Email Address
Configurability Read-only
Defaultnull
Examples
falsejenny@example.com

externalIdentifier​

The external identifier. This value is null if you are not using API-based authentication.

Type string
Configurability Read-only
Defaultnull

firstName​

The first name.

Type string
Format Plain Text
Configurability Read-only
Defaultnull
Examples
false"Jenny"

fullName​

The full name.

Type string
Format Plain Text
Configurability Read-only
Defaultnull
Examples
false"Jenny Appleseed"

groups​

A list of assigned permission groups.

Type array
Array values object
Configurability Read-only
Defaultnull
Array Object Properties

id​

The group ID.

Type string
FormatUUID
Configurability Read-only
Defaultnull

name​

The group name.

Type string
FormatUUID
Configurability Read-only
Defaultnull

Examples
false{
"id": "1234567890",
"name": "admin"
},
{
"id": "9876543210",
"name": "All users"
}

lastName​

The last name.

Type string
Format Plain Text
Configurability Read-only
Defaultnull
Examples
false"Appleseed"

locale​

The locale.

Type string
Format Plain Text
Configurability Read-only
Defaultnull
Examples
false"en"

metadata​

Relevant metadata for the item.

Type array
Array values object
Configurability Read-only
Defaultnull

profilePhotoUrl​

The profile photo URL. Available when using SSO authentication and is supplied by the IdP (Identity Provider).

Type string
Format URL
Configurability Read-only
Defaultnull
Examples
falsehttps://example.com/photo.jpg

sid​

The unique, non-sequential ID.

Type string
FormatUUID
Configurability Read-only
Defaultnull
Examples
false"user_366e154sdfg34b9bdeds32936"