UserInfo interface

Package:

@microsoft/teams-js

Represents User information.

Properties

displayName	The address book name of the current user.
id	The Microsoft Entra object id of the current user. Because a malicious party can run your content in a browser, this value should be used only as a optimization hint as to who the user is and never as proof of identity. Specifically, this value should never be used to determine if a user is authorized to access a resource; access tokens should be used for that. See getAuthToken and authenticate for more information on access tokens. This field is available only when the identity permission is requested in the manifest.
isCallingAllowed	Represents whether calling is allowed for the current logged in User
isPSTNCallingAllowed	Represents whether PSTN calling is allowed for the current logged in User
licenseType	The license type for the current user. Possible values are: "Unknown", "Teacher", "Student", "Free", "SmbBusinessVoice", "SmbNonVoice", "FrontlineWorker", "Anonymous"
loginHint	A value suitable for use when providing a login_hint to Microsoft Entra ID for authentication purposes. See Provide optional claims to your app for more information about the use of login_hint Because a malicious party can run your content in a browser, this value should be used only as a optimization hint as to who the user is and never as proof of identity. Specifically, this value should never be used to determine if a user is authorized to access a resource; access tokens should be used for that. See getAuthToken and authenticate for more information on access tokens.
tenant	The tenant related info of the current user.
userPrincipalName	The UPN of the current user. This may be an externally-authenticated UPN (e.g., guest users). Because a malicious party can run your content in a browser, this value should be used only as a optimization hint as to who the user is and never as proof of identity. Specifically, this value should never be used to determine if a user is authorized to access a resource; access tokens should be used for that. See getAuthToken and authenticate for more information on access tokens.

Property Details

displayName

The address book name of the current user.

displayName?: string

Property Value

string

id

The Microsoft Entra object id of the current user.

Because a malicious party can run your content in a browser, this value should be used only as a optimization hint as to who the user is and never as proof of identity. Specifically, this value should never be used to determine if a user is authorized to access a resource; access tokens should be used for that. See getAuthToken and authenticate for more information on access tokens.

This field is available only when the identity permission is requested in the manifest.

id: string

Property Value

string

isCallingAllowed

Represents whether calling is allowed for the current logged in User

isCallingAllowed?: boolean

Property Value

boolean

isPSTNCallingAllowed

Represents whether PSTN calling is allowed for the current logged in User

isPSTNCallingAllowed?: boolean

Property Value

boolean

licenseType

The license type for the current user. Possible values are: "Unknown", "Teacher", "Student", "Free", "SmbBusinessVoice", "SmbNonVoice", "FrontlineWorker", "Anonymous"

licenseType?: string

Property Value

string

loginHint

A value suitable for use when providing a login_hint to Microsoft Entra ID for authentication purposes. See Provide optional claims to your app for more information about the use of login_hint

Because a malicious party can run your content in a browser, this value should be used only as a optimization hint as to who the user is and never as proof of identity. Specifically, this value should never be used to determine if a user is authorized to access a resource; access tokens should be used for that. See getAuthToken and authenticate for more information on access tokens.

loginHint?: string

Property Value

string

tenant

The tenant related info of the current user.

tenant?: TenantInfo

Property Value

TenantInfo

userPrincipalName

The UPN of the current user. This may be an externally-authenticated UPN (e.g., guest users).

Because a malicious party can run your content in a browser, this value should be used only as a optimization hint as to who the user is and never as proof of identity. Specifically, this value should never be used to determine if a user is authorized to access a resource; access tokens should be used for that. See getAuthToken and authenticate for more information on access tokens.

userPrincipalName?: string

Property Value

string