IAadTokenProviderConfiguration interface

Package:

@microsoft/sp-http-base

Required strings for constructing an AadTokenProvider.

Properties

aadInstanceUrl	The sign in page used to authenticate with Azure Active Directory. Trailing slashes are forbidden.
aadSessionId	The current Azure Active Directory's session id.
aadTenantId	The Azure Active Directory's tenant id.
aadUserId	The user's Azure Active Directory id. This will be used to ensure that a valid cached token is for the current user.
enableClaimChallenges	Whether or not to enable an auth flow with support for claim challenges.
redirectUri	The page used to retrieve tokens from Azure Active Directory. This url must be listed in the developer's application redirect uris.
servicePrincipalId	The client ID of the developer's Azure Active Directory application.
userEmail	The user's email address. This will be used to ensure that the current user's identity is used for fetching auth tokens.
userPrincipalName	The user's principal name. This will be used to ensure that the current user's identity is used for fetching auth tokens. This parameter will avoid the "Request is ambiguous: multiple user identities are avaliable for the current request" error.

Property Details

aadInstanceUrl

The sign in page used to authenticate with Azure Active Directory. Trailing slashes are forbidden.

aadInstanceUrl: string;

Property Value

string

aadSessionId

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The current Azure Active Directory's session id.

aadSessionId: string;

Property Value

string

aadTenantId

The Azure Active Directory's tenant id.

aadTenantId: string;

Property Value

string

aadUserId

The user's Azure Active Directory id. This will be used to ensure that a valid cached token is for the current user.

aadUserId?: string;

Property Value

string

enableClaimChallenges

Whether or not to enable an auth flow with support for claim challenges.

enableClaimChallenges?: boolean;

Property Value

boolean

redirectUri

The page used to retrieve tokens from Azure Active Directory. This url must be listed in the developer's application redirect uris.

redirectUri: string;

Property Value

string

servicePrincipalId

The client ID of the developer's Azure Active Directory application.

servicePrincipalId: string;

Property Value

string

userEmail

Warning

This API is now deprecated.

This parameter will be ignored. Use userPrincipalName instead

The user's email address. This will be used to ensure that the current user's identity is used for fetching auth tokens.

userEmail?: string;

Property Value

string

userPrincipalName

The user's principal name. This will be used to ensure that the current user's identity is used for fetching auth tokens. This parameter will avoid the "Request is ambiguous: multiple user identities are avaliable for the current request" error.

userPrincipalName?: string;

Property Value

string