GetTokenForTeamsUserOptions interface

Package:

@azure/communication-identity

Options used to exchange an AAD access token of a Teams user for a new Communication Identity access token.

Extends

OperationOptions

Properties

clientId	Client ID of an Azure AD application to be verified against the appId claim in the Azure AD access token.
teamsUserAadToken	Azure Active Directory access token of a Teams user.
userObjectId	Object ID of an Azure AD user (Teams User) to be verified against the OID claim in the Azure AD access token.

Inherited Properties

abortSignal	The signal which can be used to abort requests.
onResponse	A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions	Options used when creating and sending HTTP requests for this operation.
serializerOptions	Options to override serialization/de-serialization behavior.
tracingOptions	Options used when tracing is enabled.

Property Details

clientId

Client ID of an Azure AD application to be verified against the appId claim in the Azure AD access token.

clientId: string

Property Value

string

teamsUserAadToken

Azure Active Directory access token of a Teams user.

teamsUserAadToken: string

Property Value

string

userObjectId

Object ID of an Azure AD user (Teams User) to be verified against the OID claim in the Azure AD access token.

userObjectId: string

Property Value

string

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From OperationOptions.abortSignal

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From OperationOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From OperationOptions.serializerOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From OperationOptions.tracingOptions