Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HarvardKeyProfile

Representation of user data as returned by HarvardKey. For more information see https://iam.harvard.edu/resources/idp-guide

Hierarchy

  • object & object
    • HarvardKeyProfile

Index

Properties

displayName

displayName: string

The format in which the user's name should be displayed. This is often (though not always) in the format of <firstName> <lastName>

example

James Waldo

eppn

eppn: string

EPPN is a shorthand for eduPersonPrincipalName, 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 nececcarily 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

givenName

givenName: string

The user's first name

example

James

sn

sn: string

The user's lastname

example

Waldo

Generated using TypeDoc