users_list_me: Show info about the logged-in user

View source: R/generated_client.R

users_list_meR Documentation

Show info about the logged-in user

Description

Show info about the logged-in user

Usage

users_list_me()

Value

A list containing the following elements:

id

integer, The ID of this user.

name

string, This user's name.

email

string, This user's email address.

username

string, This user's username.

initials

string, This user's initials.

lastCheckedAnnouncements

string, The date and time at which the user last checked their announcements.

featureFlags

list, The feature flag settings for this user.

roles

array, The roles this user has, listed by slug.

preferences

list, This user's preferences.

customBranding

string, The branding of Platform for this user.

primaryGroupId

integer, The ID of the primary group of this user.

groups

array, An array containing the following fields:

  • id integer, The ID of this group.

  • name string, The name of this group.

  • slug string, The slug of this group.

  • organizationId integer, The ID of the organization associated with this group.

  • organizationName string, The name of the organization associated with this group.

organizationName

string, The name of the organization the user belongs to.

organizationSlug

string, The slug of the organization the user belongs to.

organizationDefaultThemeId

integer, The ID of the organizations's default theme.

createdAt

string, The date and time when the user was created.

signInCount

integer, The number of times the user has signed in.

assumingRole

boolean, Whether the user is assuming a role or not.

assumingAdmin

boolean, Whether the user is assuming admin.

assumingAdminExpiration

string, When the user's admin role is set to expire.

superadminModeExpiration

string, The user is in superadmin mode when set to a DateTime. The user is not in superadmin mode when set to null.

disableNonCompliantFedrampFeatures

boolean, Whether to disable non-compliant fedramp features.

personaRole

string, The high-level role representing the current user's main permissions.

createdById

integer, The ID of the user who created this user.

lastUpdatedById

integer, The ID of the user who last updated this user.


civis documentation built on April 1, 2023, 12:01 a.m.