User alias API

A user alias object is created for each unique way a user shows up in a vendor source system such as GitHub, or 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 apex user ID.

This endpoint has the following methods:

GET /user_alias/: Get a list of user aliases and their associated information.
GET /user_alias/{id}: Get a user alias’s information by ID.

Parameters

Name	Type	Description

Name	Type	Description
`username`	string	User alias username.
`username_icontains`	string	Username contains a specific string.
`username_startwith`	string	Username starts with a specific string.
`email`	string	User alias email address.
`email__icontains`	string	Email contains a specific string.
`email__startswith`	string	Email starts with a specific string.
`apex_user`	string	Apex user ID. Filter-traversable object.
`apex_user__in`	string	Multiple apex user IDs separated by commas.
`id`	double	User alias's unique identifier.
`id__in`	double	Multiple user_alias_id values separated by commas.
`name`	string	User alias name.
`name__icontains`	string	User alias name contains a specific string.
`name__startswith`	string	User alias name starts with a specific string.
`integration`	string	Integration user alias is associated with. Filter-traversable object.
`created_at`	double	Date and time the user alias 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).
`first_activity_at`	string	User alias' first activity at date or datetime (yyyy-mm-dd hh:mm:ss)
`first_activity_at__gt`	string	User alias' first activity greater than date or datetime (yyyy-mm-dd hh:mm:ss)
`first_activity_at__gte`	string	User alias' first activity greater than or equal to date or datetime (yyyy-mm-dd hh:mm:ss)
`first_activity_at__lt`	string	User alias' first activity less than date or datetime (yyyy-mm-dd hh:mm:ss)
`first_activity_at__lte`	string	User alias' first activity less than or equal to date or datetime (yyyy-mm-dd hh:mm:ss)
`last_activity_at`	string	User alias's last activity at date or datetime (yyyy-mm-dd hh:mm:ss)
`last_activity_at__gt`	string	User alias' last activity greater than date or datetime (yyyy-mm-dd hh:mm:ss)
`last_activity_at__gte`	string	User alias' last activity greater than or equal to date or datetime (yyyy-mm-dd hh:mm:ss)
`last_activity_at__lt`	string	User alias' last activity less than date or datetime (yyyy-mm-dd hh:mm:ss)
`last_activity_at__lte`	string	User alias' last activity less than or equal to date or datetime (yyyy-mm-dd hh:mm:ss)
`ordering`	string	Which fields to use when ordering the results.
`search`	string	A search term

Example response

   {
      "id": 1138709,
      "username": null,
      "name": "Stephanie Ventura",
      "email": "sventura@example.com",
      "integration": {
        "id": 955,
        "name": "engineering-github",
        "vendor_meta": {
          "name": "github",
          "title": "GitHub Cloud",
          "services": [
            {
              "name": "repo",
              "display": "Repos"
            },
            {
              "name": "ticket",
              "display": "Tickets"
            },
            {
              "name": "pull_request",
              "display": "Pull Requests"
            }
          ],
          "icon": "vendors/github",
          "auth_types": [
            "oauth",
            "access_token"
          ],
          "is_cloud": true,
          "enable_webhooks": true,
          "allow_multiple_accounts": true
        },
        "audit_created_by": 7,
        "org": 1234
      },
      "org_id": 1234,
      "vendor_type": "github",
      "external_id": "GP_UNIQUE_ID:xxxxxxxx",
      "created_at": "2024-07-12T19:30:15.630499",
      "avatar_url": "https://secure.gravatar.com/avatar/example.jpg",
      "created_from_group": false,
      "apex_user": {
        "id": 2260265,
        "name": "Stephanie Ventura",
        "email": "sventura@examle.com",
        "avatar_url": "https://secure.gravatar.com/avatar/example.jpg"
      }
    }