User alias API

Tags: Flow

A user alias object is created for each unique way a user shows up in a source system such as GitHub, and Jira. One person may do work under many different email addresses or user ids. The user alias object is a record of each of those identities. Many user aliases can be merged together to create one user id.

Who can use this?

 Core
Plus
 
   

 

Supported request

Get a collection of user aliases:

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

Fields

NameTypeDescription
usernamestringUser alias username.
username_icontainsstringUsername contains a specific string.
username_startwithstringUsername starts with a specific string.
emailstringUser alias email address.
email__icontainsstringEmail contains a specific string.
email__startswithstringEmail starts with a specific string.
apex_userstringApex user ID. Filter-traversable object.
apex_user__instringMultiple apex user IDs separated by commas.
iddoubleUser alias's unique identifier.
id__indoubleMultiple user_alias_id values separated by commas.
namestringUser alias name.
name__icontainsstringUser's alias name contains a specific string.
name__startswithstringUser's alias name starts with a specific string.
integrationstringIntegration user alias is associated with. Filter-traversable object.
created_atdoubleDate and time the user alias was created.
created_at__gtstringRecords greater than date or datetime (yyyy-mm-dd hh:mm:ss).
created_at__gtestringRecords greater than or equal to date or datetime (yyyy-mm-dd hh:mm:ss).
created_at__ltstringRecords less than date or datetime (yyyy-mm-dd hh:mm:ss).
created_at__ltestringRecords less than or equal to date or datetime (yyyy-mm-dd hh:mm:ss).
first_activity_atstringUser alias' first activity at date or datetime (yyyy-mm-dd hh:mm:ss)
first_activity_at__gtstringUser alias' first activity greater than date or datetime (yyyy-mm-dd hh:mm:ss)
first_activity_at__gtestringUser alias' first activity greater than or equal to date or datetime (yyyy-mm-dd hh:mm:ss)
first_activity_at__ltstringUser alias' first activity less than date or datetime (yyyy-mm-dd hh:mm:ss)
first_activity_at__ltestringUser alias' first activity less than or equal to date or datetime (yyyy-mm-dd hh:mm:ss)
last_activity_atstringUser alias's last activity at date or datetime (yyyy-mm-dd hh:mm:ss)
last_activity_at__gtstringUser alias' last activity greater than date or datetime (yyyy-mm-dd hh:mm:ss)
last_activity_at__gtestringUser alias' last activity greater than or equal to date or datetime (yyyy-mm-dd hh:mm:ss)
last_activity_at__ltstringUser alias' last activity less than date or datetime (yyyy-mm-dd hh:mm:ss)
last_activity_at__ltestringUser alias' last activity less than or equal to date or datetime (yyyy-mm-dd hh:mm:ss)
orderingstringWhich fields to use when ordering the results.
searchstringA search term

Example response

back to top


If you need help, please contact Pluralsight Support.