UserInfo Class

Beta  

Information on the authenticated user.

Methods

Name Description
constructor(id: string, email?: { id: string, isVerified?: undefined | false | true }, profile?: { firstName: string, lastName: string, name?: undefined | string, preferredUserName?: undefined | string }, organization?: { id: string, name: string }, featureTracking?: { ultimateSite: string, usageCountryIso: string }): UserInfo    
fromJson(jsonObj: any): UserInfo | undefined Static Creates UserInfo from JSON obtained from typical Oidc clients  

Properties

Name Type Description
email ConstructorProperty undefined | { id: string, isVerified?: undefined | false | true } Email details  
featureTracking ConstructorProperty undefined | { ultimateSite: string, usageCountryIso: string } Feature tracking information associated with the user  
id ConstructorProperty string Id of the user  
organization ConstructorProperty undefined | { id: string, name: string } Organization the user belongs to  
profile ConstructorProperty undefined | { firstName: string, lastName: string, name?: undefined | string, preferredUserName?: undefined | string } Profile of the user  

Defined in

Last Updated: 13 June, 2024