IAadTokenProvider interface
Esta classe permite que um programador obtenha tokens OAuth2 de Azure AD.
Os tokens OAuth2 são utilizados para autenticar o utilizador a partir da página do SharePoint para outros serviços, como o PowerBI, Sway, Exchange, Yammer, etc.
Comentários
O AadTokenProvider está a substituir o /_api. SP. Ponto final OAuth.Token/Acquire para autenticação com ADAL.js. Num futuro próximo, quando Azure AD v2.0 suportar os mesmos cenários que a versão original, mudaremos para MSAL.
Métodos
| get |
Obtém o token OAuth2 do AAD para um recurso se o utilizador com sessão iniciada tiver acesso a esse recurso. O token OAuth2 NÃO DEVE ser colocado em cache pelo chamador, uma vez que já está em cache pelo próprio método. Um exemplo de um resourceEndpoint seria https://sdfpilot.outlook.com |
| get |
Eventos
| on |
Notifica o programador antes de ocorrer um redirecionamento de página inteira. |
| popup |
Notifica o programador antes de ocorrer um redirecionamento de página inteira. |
| token |
Notifica o programador quando o Token Acquistion requer a ação do utilizador. |
Detalhes do método
getToken(resourceEndpoint, options)
Obtém o token OAuth2 do AAD para um recurso se o utilizador com sessão iniciada tiver acesso a esse recurso.
O token OAuth2 NÃO DEVE ser colocado em cache pelo chamador, uma vez que já está em cache pelo próprio método.
Um exemplo de um resourceEndpoint seria https://sdfpilot.outlook.com
getToken(resourceEndpoint: string, options?: IGetTokenOptions): Promise<string>;Parâmetros
- resourceEndpoint
-
string
o recurso para o qual o token deve ser obtido
- options
- IGetTokenOptions
Retornos
Promise<string>
Uma promessa que será completada com o token ou que será rejeitada com uma mensagem de erro
getToken(resourceEndpoint, useCachedToken)
getToken(resourceEndpoint: string, useCachedToken?: boolean): Promise<string>;Parâmetros
- resourceEndpoint
-
string
- useCachedToken
-
boolean
Retornos
Promise<string>
Detalhes do evento
onBeforeRedirectEvent
Notifica o programador antes de ocorrer um redirecionamento de página inteira.
readonly onBeforeRedirectEvent: SPEvent<IBeforeRedirectEventArgs>;Tipo de evento
popupEvent
Notifica o programador antes de ocorrer um redirecionamento de página inteira.
readonly popupEvent: SPEvent<IPopupEventArgs>;Tipo de evento
tokenAcquisitionEvent
Notifica o programador quando o Token Acquistion requer a ação do utilizador.
readonly tokenAcquisitionEvent: SPEvent<ITokenAcquisitionEventArgs>;