Display Name

Overview

The transform forms an identity’s Display Name value using the Preferred Name value when it exists over the Given Name (first name) value. The Family Name (last name) value is then appended to form the complete Display Name, e.g., ("Preferred Name" or "Given Name") + "Family Name"

Transform Structure

The displayName generator transform is intended for using Preferred Name over Given Name to create an identity’s Display Name.

{
  "name": "Display Name Transform",
  "type": "displayName",
  "attributes": {
    "input": "input"
  }
}

Attributes

• Required Attributes
  • type - This must always be set to displayName.
  • name - This is a required attribute for all transforms. It represents the name of the transform as it will appear in the UI's dropdown menus.
  • attributes - The attributes key must be included and not null for the transform to work properly.

Examples

This transform takes the user's Preferred Name or Given Name, and appends the user's Family Name. For example:

If the user's Preferred Name is John, Given Name is Jonathan, and Family Name is Doe, the Display Name would be John Doe.

If the user's Preferred Name is not set, Given Name is Jonathan, and Family Name is Doe, the Display Name would be Jonathan Doe.

Transform Request Body:

{
  "name": "Display Name Transform",
  "type": "displayName",
  "attributes": {
    "input": "input"
  }
}