Users

Tags: Flow

Overview

A user object creates and acts on other objects.  When multiple user records are associated with an individual, due to differences in email or variations in a name for example, user records can be "merged" under a single "apex" user record.

Supported request

Get a collection of users:

https://flow.pluralsight.com/v3/customer/core/users/

Fields

Name

Type

Description

id

double

User's unique identifier.

id__in

double

Multiple user_id values separated by commas.

name

string

User’s name.

name__icontains

string

User's name contains a specific string.

name__startswith

string

User's name starts with a specific string.

email

string

User's email address.

email__icontains

string

Email contains a specific string.

email__startswith

string

Email starts with specific string.

hidden_from_reports

boolean

Returns true to indicate the user's record is excluded.

org_id

double

Org's unique identifier

created_at

double

Date and time theuser record was created.

created_at__gt

string

Records greater than date or datetime (yyyy-mm-dd hh:mm:ss).

created_at__gte

string

Records greater than or equal to date or datetime (yyyy-mm-dd hh:mm:ss).

created_at__lt

string

Records less than date or datetime (yyyy-mm-dd hh:mm:ss).

created_at__lte

string

Records less than or equal to date or datetime (yyyy-mm-dd hh:mm:ss).

teams

string

An array of TEAMS associated with the User. Filter-traversable object.

has_login

boolean

Returns true if User has a login.

pending_invitation

boolean

Returns true if the user has been invited to the account but has not signed in.

alias_count

double

Alias count.

alias_count__gt

double

Alias count is greater than the input number.

alias_count__gte

double

Alias count is greater than or equal the input number.

alias_count__lt

double

Alias count is less than the input number.

alias_count__lte

double

Alias count is less than or equal to the input number.

last_activity_at

string

User's last activity at date or datetime (yyyy-mm-dd hh:mm:ss)

last_activity_at__gt

string

User's last activity greater than date or datetime (yyyy-mm-dd hh:mm:ss)

last_activity_at__gte

string

User's last activity greater than or equal to date or datetime (yyyy-mm-dd hh:mm:ss)

last_activity_at__lt

string

User's last activity less than date or datetime (yyyy-mm-dd hh:mm:ss)

last_activity_at__lte

string

User's last activity less than ore equal to date or datetime (yyyy-mm-dd hh:mm:ss)

first_activity_at

string

User's first activity at date or datetime (yyyy-mm-dd hh:mm:ss)

first_activity_at__gt

string

User's first activity greater than date or datetime (yyyy-mm-dd hh:mm:ss)

first_activity_at__gte

string

User's first activity greater than or equal to date or datetime (yyyy-mm-dd hh:mm:ss)

first_activity_at__lt

string

User's first activity less than date or datetime (yyyy-mm-dd hh:mm:ss)

first_activity_at__lte

string

User's first activity less than or equal to date or datetime (yyyy-mm-dd hh:mm:ss)

avatar URL

string

External URL for user's avatar image.

avatar_exists

boolean

Returns true if an avatar exists for a user.

invitation_id

string

Unique identifier for inviation.

login_enabled

boolean

Returns true if users's login is enabled.

is_saml

boolean

Returns true if user's login is controlled via SAML Integration.

ordering

string

Valid ordering fields are id, name, email, hidden_from_reports, has_login and alias_count.

search

string

A search term

Example response

back to top


If you need help, please email support@pluralsight.com for 24/7 assistance.