Edit

Share via

TeamsChannelAccount interface

  • Reference
Package:
botframework-schema
Extends
ChannelAccount

Properties

email
givenName
surname
tenantId
userPrincipalName
userRole

Inherited Properties

aadObjectId

This account's object ID within Azure Active Directory (AAD)
id

Channel id for the user or bot on this channel (Example: [email protected], or @joesmith or 123456)
name

Display friendly name
role

Role of the entity behind the account (Example: User, Bot, etc.). Possible values include: 'user', 'bot', 'skill'

Property Details

email 

email?: string

Property Value

string

givenName 

givenName?: string

Property Value

string

surname 

surname?: string

Property Value

string

tenantId 

tenantId?: string

Property Value

string

userPrincipalName 

userPrincipalName?: string

Property Value

string

userRole 

userRole?: string

Property Value

string

Inherited Property Details

aadObjectId

This account's object ID within Azure Active Directory (AAD)

aadObjectId?: string

Property Value

string

Inherited From ChannelAccount.aadObjectId

id

Channel id for the user or bot on this channel (Example: [email protected], or @joesmith or 123456)

id: string

Property Value

string

Inherited From ChannelAccount.id

name

Display friendly name

name: string

Property Value

string

Inherited From ChannelAccount.name

role

Role of the entity behind the account (Example: User, Bot, etc.). Possible values include: 'user', 'bot', 'skill'

role?: RoleTypes | string

Property Value

RoleTypes | string

Inherited From ChannelAccount.role