IAadTokenProvider interface
Esta clase permite a un desarrollador obtener tokens de OAuth2 de Azure AD.
Los tokens de OAuth2 se usan para autenticar al usuario desde la página de SharePoint en otros servicios como PowerBI, Sway, Exchange, Yammer, etc.
Comentarios
AadTokenProvider está reemplazando el objeto /_api. SP. OAuth.Token/Adquirir punto de conexión para la autenticación con ADAL.js. En algún momento próximo, cuando Azure AD v2.0 pueda admitir los mismos escenarios que la versión original, cambiaremos a MSAL.
Métodos
| get |
Captura el token de OAuth2 de AAD para un recurso si el usuario que ha iniciado sesión actualmente tiene acceso a ese recurso. El autor de la llamada no debe almacenar en caché el token de OAuth2, ya que el propio método ya lo almacena en caché. Un ejemplo de un resourceEndpoint sería https://sdfpilot.outlook.com |
| get |
Eventos
| on |
Notifica al desarrollador antes de que se produzca una redirección de página completa. |
| popup |
Notifica al desarrollador antes de que se produzca una redirección de página completa. |
| token |
Notifica al desarrollador cuando Token Acquistion requiere la acción del usuario. |
Detalles del método
getToken(resourceEndpoint, options)
Captura el token de OAuth2 de AAD para un recurso si el usuario que ha iniciado sesión actualmente tiene acceso a ese recurso.
El autor de la llamada no debe almacenar en caché el token de OAuth2, ya que el propio método ya lo almacena en caché.
Un ejemplo de un resourceEndpoint sería https://sdfpilot.outlook.com
getToken(resourceEndpoint: string, options?: IGetTokenOptions): Promise<string>;
Parámetros
- resourceEndpoint
-
string
el recurso para el que se debe obtener el token
- options
- IGetTokenOptions
Devoluciones
Promise<string>
Una promesa que se completará con el token o que se rechazará con un mensaje de error.
getToken(resourceEndpoint, useCachedToken)
getToken(resourceEndpoint: string, useCachedToken?: boolean): Promise<string>;
Parámetros
- resourceEndpoint
-
string
- useCachedToken
-
boolean
Devoluciones
Promise<string>
Detalles del evento
onBeforeRedirectEvent
Notifica al desarrollador antes de que se produzca una redirección de página completa.
readonly onBeforeRedirectEvent: SPEvent<IBeforeRedirectEventArgs>;
Tipo de evento
popupEvent
Notifica al desarrollador antes de que se produzca una redirección de página completa.
readonly popupEvent: SPEvent<IPopupEventArgs>;
Tipo de evento
tokenAcquisitionEvent
Notifica al desarrollador cuando Token Acquistion requiere la acción del usuario.
readonly tokenAcquisitionEvent: SPEvent<ITokenAcquisitionEventArgs>;