IPublicClientApplication interface

用于定义公共 API 签名的 PublicClientApplication 类的接口

方法

acquireTokenByCode(AuthorizationCodeRequest)

通过交换从 OAuth 2.0 授权代码流的第一步收到的授权代码来获取令牌

acquireTokenByDeviceCode(DeviceCodeRequest)

使用 OAuth2.0 设备代码流从颁发机构获取令牌

acquireTokenByRefreshToken(RefreshTokenRequest)

通过交换为新令牌集提供的刷新令牌来获取令牌

acquireTokenByUsernamePassword(UsernamePasswordRequest)

通过交换客户端应用程序用户名和密码获取凭据来获取密码授予的令牌

acquireTokenInteractive(InteractiveRequest)

以交互方式获取令牌

acquireTokenSilent(SilentFlowRequest)

当用户指定请求令牌的帐户时,以无提示方式获取令牌

clearCache()

清除缓存

getAllAccounts()

获取所有缓存帐户

getAuthCodeUrl(AuthorizationUrlRequest)

创建授权请求的 URL

getLogger()

返回记录器实例

getTokenCache()

获取应用程序的令牌缓存

setLogger(Logger)

将配置中的默认记录器集替换为新的记录器以及新配置

signOut(SignOutRequest)

删除与给定帐户关联的缓存项目

方法详细信息

acquireTokenByCode(AuthorizationCodeRequest)

通过交换从 OAuth 2.0 授权代码流的第一步收到的授权代码来获取令牌

function acquireTokenByCode(request: AuthorizationCodeRequest): Promise<AuthenticationResult>

参数

返回

acquireTokenByDeviceCode(DeviceCodeRequest)

使用 OAuth2.0 设备代码流从颁发机构获取令牌

function acquireTokenByDeviceCode(request: DeviceCodeRequest): Promise<null | AuthenticationResult>

参数

返回

Promise<null | AuthenticationResult>

acquireTokenByRefreshToken(RefreshTokenRequest)

通过交换为新令牌集提供的刷新令牌来获取令牌

function acquireTokenByRefreshToken(request: RefreshTokenRequest): Promise<null | AuthenticationResult>

参数

返回

Promise<null | AuthenticationResult>

acquireTokenByUsernamePassword(UsernamePasswordRequest)

警告

现已弃用此 API。

  • Use a more secure flow instead

通过交换客户端应用程序用户名和密码获取凭据来获取密码授予的令牌

function acquireTokenByUsernamePassword(request: UsernamePasswordRequest): Promise<null | AuthenticationResult>

参数

返回

Promise<null | AuthenticationResult>

acquireTokenInteractive(InteractiveRequest)

以交互方式获取令牌

function acquireTokenInteractive(request: InteractiveRequest): Promise<AuthenticationResult>

参数

返回

acquireTokenSilent(SilentFlowRequest)

当用户指定请求令牌的帐户时,以无提示方式获取令牌

function acquireTokenSilent(request: SilentFlowRequest): Promise<AuthenticationResult>

参数

返回

clearCache()

清除缓存

function clearCache()

getAllAccounts()

获取所有缓存帐户

function getAllAccounts(): Promise<AccountInfo[]>

返回

Promise<AccountInfo[]>

getAuthCodeUrl(AuthorizationUrlRequest)

创建授权请求的 URL

function getAuthCodeUrl(request: AuthorizationUrlRequest): Promise<string>

参数

返回

Promise<string>

getLogger()

返回记录器实例

function getLogger(): Logger

返回

getTokenCache()

获取应用程序的令牌缓存

function getTokenCache(): TokenCache

返回

setLogger(Logger)

将配置中的默认记录器集替换为新的记录器以及新配置

function setLogger(logger: Logger)

参数

logger
Logger

signOut(SignOutRequest)

删除与给定帐户关联的缓存项目

function signOut(request: SignOutRequest): Promise<void>

参数

request
SignOutRequest

返回

Promise<void>