Interface HarvardKeyResponse

Type declaration

• Optional authenticationFailure?: object

  Will only be present if the user validations fails

  • code: string

    A short descriptor for the error See https://apereo.github.io/cas/4.2.x/protocol/CAS-Protocol-Specification.html#253-error-codes

    example

    INVALID_REQUEST

  • Optional description?: string

    A longer description for the failure

• Optional authenticationSuccess?: object

  This field will only be present if the user successfully validates. Note that there are potentially more fields that can be included under attributes, but we're only listing here the fields that were included with the course planner application request

  • attributes: object

    • eduPersonPrincipalName: string[]

      eduPersonPrincipalName (EPPN), is an attribute defined in the Internet2 eduPerson object class specification that is intended to uniquely identify a user at a given institution. At Harvard, we create an EPPN for each user by transforming a long "opaque internal identifier" into a shorter opaque identifier and then adding on "@harvard.edu" - for example, 4A2849CF119852@harvard.edu.

      An EPPN remains the same even if a user change their name — making it, in identity management terminology, unique and persistent.

      Please note: Whilst eppn may look the same as an email address - an email addresses can change (for example, if a user changes their name etc.), whilst an EPPN cannot. This means that EPPN is NOT necessarily the same as email(inherited from Profile) and the two should not be considered interchangeable

      For more information on harvard key and identity management, see the IAM web site

      example

      [4A2849CF119852@harvard.edu]

    • Optional givenName?: string[]

      The user's first name

      example

      [John]

    • Optional memberOf?: GROUP[]

      A list of all grouper groups in which the user is a member.

      example:

      [ 'harvard:org:schools:seas:managed:seas-course-planning:roles-admin-seas-course-planning' 'harvard:org:schools:seas:managed:seas-course-planning:roles-all-users-seas-course-planning' ]

    • Optional sn?: string[]

      The user's last name

      example

      [Harvard]

  • user: string

    The user's eppn