/
Display a User's Preferred Name via SSO

Display a User's Preferred Name via SSO

Ready Education provides support for preferred name in the Authentication flow. Adding preferred name support allows students to see their preferred name in "My Profile" and when posting on the Campus Wall. 

Current Support: 

  • SAML - supported

  • CAS - supported

SAML Preferred Name

Here are your options for adding Preferred Name support:

  1. Release preferred name in the "First Name" and/or "Last Name" SAML attribute

  • Release "preferred name" instead of the current legal name in the First Name and/or Last Name fields. 

    • For example, release "Bob" instead of "Robert" for First Name. 

  • The First Name Attribute in our Metadata is: <md:RequestedAttribute Name="urn:oid:2.5.4.42" FriendlyName="firstName" isRequired="true"/>

  • The Last Name Attribute in our Metadata is: <md:RequestedAttribute Name="urn:oid:2.5.4.4" FriendlyName="lastName" isRequired="true"/>

Ready Education Requirements: No configuration change required from Ready Education. Immediately testable once your SAML has been configured. Users may need to log out and log in to see the changes. 

  1. Release an additional attribute with preferred name 

Release "preferred name" via an additional attribute such as "displayName" or "UserPrincipalName". Regardless of how the attribute is stored or named, we're able to map to an additional preferred name field. We do require the attribute to release the name in one of these three accepted formats: 

  • "Last Name, First Name"

  • "First Name Last Name"

  • "First Name"

For example, a user with a legal name of Robert Smith but a preferred name of Bob Smith would need the attribute released in one of these three formats: 

  • "Smith, Bob"

  • "Bob Smith"

  • "Bob"

Ready Education Requirements: We will need to configure the mapping to your preferred name field. Please provide the attribute name in this format: 

  • <md:Requested Attribute Name="urn:oid:2.16.840.1.113730.3.1.241" FriendlyName="displayName" isRequired="true"/>

Once provided, we will configure the mapping. Immediately testable after mapping. Users may need to log out and log in to see the changes. 

CAS Preferred Name 

  • Supported for givenName in the format of "Smith, Bob". Release as an attribute in your CAS attribute statement

  1. Release preferred name in the "First Name" and/or "Last Name" via CAS statement

  • Release "preferred name" instead of the current legal name in the First Name and/or Last Name fields. 

    • For example, for the First Name, release "Bob" instead of "Robert".  

Ready Education Requirements: No configuration change required from Ready Education. Immediately testable once your CAS has been configured. Users may need to log out and log in to see the changes. 

  1. Release an additional attribute called "displayName" 

Release "preferred name" via an additional attribute "displayName". We only accept the attribute in the following format: 

  • "Last Name, First Name"

For example, a user with a legal name of Robert Smith but a preferred name of Bob Smith would need the attribute released as: 

  • "Smith, Bob"

Ready Education Requirements: No configuration change required from Ready Education. Immediately testable once your CAS has been configured to release displayName. Users may need to log out and log in to see the changes.