Class IdentityClient

Package version

Hierarchy

any
- IdentityClient

Index

Constructors

constructor

Properties

authorityHost

Methods

Constructors

constructor

new IdentityClient(options?: TokenCredentialOptions): IdentityClient

- Defined in home/vsts/work/1/s/sdk/identity/identity/src/client/identityClient.ts:40
Parameters
- Optional options: TokenCredentialOptions
Returns IdentityClient

Properties

authorityHost

authorityHost: string

Methods

createWebResource

createWebResource(requestOptions: RequestPrepareOptions): WebResource

- Defined in home/vsts/work/1/s/sdk/identity/identity/src/client/identityClient.ts:66
Parameters
- requestOptions: RequestPrepareOptions
Returns WebResource

refreshAccessToken

refreshAccessToken(tenantId: string, clientId: string, scopes: string, refreshToken: string | undefined, clientSecret: string | undefined, expiresOnParser?: undefined | ((responseBody: any) => number), options?: GetTokenOptions): Promise<TokenResponse | null>

- Defined in home/vsts/work/1/s/sdk/identity/identity/src/client/identityClient.ts:110
Parameters
- tenantId: string
- clientId: string
- scopes: string
- refreshToken: string | undefined
- clientSecret: string | undefined
- Optional expiresOnParser: undefined | ((responseBody: any) => number)
- Optional options: GetTokenOptions
Returns Promise<TokenResponse | null>

sendTokenRequest

sendTokenRequest(webResource: WebResource, expiresOnParser?: undefined | ((responseBody: any) => number)): Promise<TokenResponse | null>

- Defined in home/vsts/work/1/s/sdk/identity/identity/src/client/identityClient.ts:72
Parameters
- webResource: WebResource
- Optional expiresOnParser: undefined | ((responseBody: any) => number)
Returns Promise<TokenResponse | null>

Static getDefaultOptions

getDefaultOptions(): TokenCredentialOptions

- Defined in home/vsts/work/1/s/sdk/identity/identity/src/client/identityClient.ts:187
Returns TokenCredentialOptions

Generated using TypeDoc