Share via

TeamsChannelAccount interface

Package:
@microsoft/agents-hosting-extensions-teams

Represents a Teams channel account.

Extends
ChannelAccount

Properties

email

Email address of the user.
givenName

Given name of the user.
surname

Surname of the user.
userPrincipalName

User principal name of the user.
userRole

Role of the user in the team.

Inherited Properties

aadObjectId

The Azure Active Directory object ID of the channel account.
agenticAppBlueprintId

The parent blueprint ID of an agentic instance
agenticAppId

The client ID of an agentic app
agenticUserId

The UPN of an agentic user
id

The unique identifier of the channel account.
membershipSources

List of membership sources associated with the channel account.
name

The name of the channel account.
properties

Additional properties of the channel account.
role

The role of the channel account.
tenantId

Tenant ID of the user.

Property Details

email

Email address of the user.

email?: string

Property Value

string

givenName

Given name of the user.

givenName?: string

Property Value

string

surname

Surname of the user.

surname?: string

Property Value

string

userPrincipalName

User principal name of the user.

userPrincipalName?: string

Property Value

string

userRole

Role of the user in the team.

userRole?: string

Property Value

string

Inherited Property Details

aadObjectId

The Azure Active Directory object ID of the channel account.

aadObjectId?: string

Property Value

string

Inherited From ChannelAccount.aadObjectId

agenticAppBlueprintId

The parent blueprint ID of an agentic instance

agenticAppBlueprintId?: string

Property Value

string

Inherited From ChannelAccount.agenticAppBlueprintId

agenticAppId

The client ID of an agentic app

agenticAppId?: string

Property Value

string

Inherited From ChannelAccount.agenticAppId

agenticUserId

The UPN of an agentic user

agenticUserId?: string

Property Value

string

Inherited From ChannelAccount.agenticUserId

id

The unique identifier of the channel account.

id?: string

Property Value

string

Inherited From ChannelAccount.id

membershipSources

List of membership sources associated with the channel account.

membershipSources?: MembershipSource[]

Property Value

MembershipSource[]

Inherited From ChannelAccount.membershipSources

name

The name of the channel account.

name?: string

Property Value

string

Inherited From ChannelAccount.name

properties

Additional properties of the channel account.

properties?: unknown

Property Value

unknown

Inherited From ChannelAccount.properties

role

The role of the channel account.

role?: string

Property Value

string

Inherited From ChannelAccount.role

tenantId

Tenant ID of the user.

tenantId?: string

Property Value

string

Inherited From ChannelAccount.tenantId