AuthenticatePopUpParameters interface

  • Reference
Package:
@microsoft/teams-js

Describes the authentication pop-up parameters

Properties

height

The preferred height for the pop-up. This value can be ignored if outside the acceptable bounds.
isExternal

Some identity providers restrict their authentication pages from being displayed in embedded browsers (e.g., a web view inside of a native application) If the identity provider you are using prevents embedded browser usage, this flag should be set to true to enable the authentication page specified in the url property to be opened in an external browser. If this flag is false, the page will be opened directly within the current hosting application.

This flag is ignored when the host for the application is a web app (as opposed to a native application) as the behavior is unnecessary in a web-only environment without an embedded browser.
url

The URL for the authentication pop-up.
width

The preferred width for the pop-up. This value can be ignored if outside the acceptable bounds.

Property Details

height

The preferred height for the pop-up. This value can be ignored if outside the acceptable bounds.

height?: number

Property Value

number

isExternal

Some identity providers restrict their authentication pages from being displayed in embedded browsers (e.g., a web view inside of a native application) If the identity provider you are using prevents embedded browser usage, this flag should be set to true to enable the authentication page specified in the url property to be opened in an external browser. If this flag is false, the page will be opened directly within the current hosting application.

This flag is ignored when the host for the application is a web app (as opposed to a native application) as the behavior is unnecessary in a web-only environment without an embedded browser.

isExternal?: boolean

Property Value

boolean

url

The URL for the authentication pop-up.

url: string

Property Value

string

width

The preferred width for the pop-up. This value can be ignored if outside the acceptable bounds.

width?: number

Property Value

number