@azure/identity

Index

Enumerations

AzureAuthorityHosts

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

BrowserLoginStyle

BrowserLoginStyle: "redirect" | "popup"

The "login style" to use in the authentication flow:

"redirect" redirects the user to the authentication page and then redirects them back to the page once authentication is completed.
"popup" opens a new browser window through with the redirect flow is initiated. The user's existing browser window does not leave the current page

DeviceCodePromptCallback

DeviceCodePromptCallback: (deviceCodeInfo: DeviceCodeInfo) => void

Defines the signature of a callback which will be passed to DeviceCodeCredential for the purpose of displaying authentication details to the user.

Type declaration

- (deviceCodeInfo: DeviceCodeInfo): void
- Parameters
  - deviceCodeInfo: DeviceCodeInfo
  Returns void

Variables

Const AggregateAuthenticationErrorName

AggregateAuthenticationErrorName: "AggregateAuthenticationError" = "AggregateAuthenticationError"

The Error.name value of an AggregateAuthenticationError

Const AllSupportedEnvironmentVariables

AllSupportedEnvironmentVariables: string[] = ["AZURE_TENANT_ID","AZURE_CLIENT_ID","AZURE_CLIENT_SECRET","AZURE_CLIENT_CERTIFICATE_PATH","AZURE_USERNAME","AZURE_PASSWORD"]

Contains the list of all supported environment variable names so that an appropriate error message can be generated when no credentials can be configured.

internal

Const AppServiceMsiApiVersion

AppServiceMsiApiVersion: "2017-09-01" = "2017-09-01"

Const AuthenticationErrorName

AuthenticationErrorName: "AuthenticationError" = "AuthenticationError"

The Error.name value of an AuthenticationError

Const AzureAccountClientId

AzureAccountClientId: "aebc6443-996d-45c2-90f0-388ff96faa56" = "aebc6443-996d-45c2-90f0-388ff96faa56"

Const BrowserNotSupportedError

BrowserNotSupportedError: Error = new Error("getAuthorityHostEnvironment is not supported in the browser.")

Const CommonTenantId

CommonTenantId: "common" = "common"

Const DefaultAuthorityHost

DefaultAuthorityHost: "https://login.microsoftonline.com" = "https://login.microsoftonline.com"

Const DefaultScopeSuffix

DefaultScopeSuffix: "/.default" = "/.default"

Const ImdsApiVersion

ImdsApiVersion: "2018-02-01" = "2018-02-01"

Const ImdsEndpoint

ImdsEndpoint: "http://169.254.169.254/metadata/identity/oauth2/token" = "http://169.254.169.254/metadata/identity/oauth2/token"

Const SelfSignedJwtLifetimeMins

SelfSignedJwtLifetimeMins: 10 = 10

Const VSCodeUserName

VSCodeUserName: "VS Code Azure" = "VS Code Azure"

Const logger

logger: CredentialLogger = credentialLogger("VSCodeCredential")

The AzureLogger used for all clients within the identity package

Let testFunction

testFunction: ((t: number) => Promise<void>) | undefined

Functions

_setDelayTestFunction

_setDelayTestFunction(func?: undefined | ((t: number) => Promise<void>)): void

- Defined in home/vsts/work/1/s/sdk/identity/identity/src/util/delay.ts:23
internal

Parameters
- Optional func: undefined | ((t: number) => Promise<void>)
Returns void

addMinutes

addMinutes(date: Date, minutes: number): Date

- Defined in home/vsts/work/1/s/sdk/identity/identity/src/credentials/clientCertificateCredential.ts:22
Parameters
- date: Date
- minutes: number
Returns Date

convertOAuthErrorResponseToErrorResponse

convertOAuthErrorResponseToErrorResponse(errorBody: OAuthErrorResponse): ErrorResponse

- Defined in home/vsts/work/1/s/sdk/identity/identity/src/client/errors.ts:165
Parameters
- errorBody: OAuthErrorResponse
Returns ErrorResponse

createSpan

createSpan(operationName: string, options?: GetTokenOptions): { options: GetTokenOptions; span: Span }

- Defined in home/vsts/work/1/s/sdk/identity/identity/src/util/tracing.ts:13
Creates a span using the global tracer.

Parameters
- operationName: string
- Default value options: GetTokenOptions = {}
  
  The options for the underlying http request.
Returns { options: GetTokenOptions; span: Span }
- options: GetTokenOptions
- span: Span

credentialLogger

credentialLogger(title: string, log?: AzureLogger): CredentialLogger

- Defined in home/vsts/work/1/s/sdk/identity/identity/src/util/logging.ts:123
Generates a CredentialLogger, which is a logger declared at the credential's constructor, and used at any point in the credential. It has all the properties of a CredentialLoggerInstance, plus other logger instances, one per method.

It logs with the format:

[title] => [message] [title] => getToken() => [message]

Parameters
- title: string
- Default value log: AzureLogger = logger
Returns CredentialLogger

credentialLoggerInstance

credentialLoggerInstance(title: string, parent?: CredentialLoggerInstance, log?: AzureLogger): CredentialLoggerInstance

- Defined in home/vsts/work/1/s/sdk/identity/identity/src/util/logging.ts:87
Generates a CredentialLoggerInstance.

It logs with the format:

[title] => [message]

Parameters
- title: string
- Optional parent: CredentialLoggerInstance
- Default value log: AzureLogger = logger
Returns CredentialLoggerInstance

delay

delay(t: number): Promise<void>

- Defined in home/vsts/work/1/s/sdk/identity/identity/src/util/delay.ts:12
A wrapper for setTimeout that resolves a promise after t milliseconds.

internal

Parameters
- t: number
  
  The number of milliseconds to be delayed.
Returns Promise<void>

Resolved promise

formatError

formatError(error: Error | string): string

- Defined in home/vsts/work/1/s/sdk/identity/identity/src/util/logging.ts:59
Formatting the success event on the credentials

Parameters
- error: Error | string
Returns string

formatSuccess

formatSuccess(scope: string | string[]): string

- Defined in home/vsts/work/1/s/sdk/identity/identity/src/util/logging.ts:52
Formatting the success event on the credentials

Parameters
- scope: string | string[]
Returns string

getAuthorityHostEnvironment

getAuthorityHostEnvironment(): undefined | { authorityHost: any }

- Defined in home/vsts/work/1/s/sdk/identity/identity/src/util/authHostEnv.ts:1
Returns undefined | { authorityHost: any }

getDefaultAzureCredential

getDefaultAzureCredential(): TokenCredential

- Defined in home/vsts/work/1/s/sdk/identity/identity/src/index.ts:47
Returns a new instance of the DefaultAzureCredential.

Returns TokenCredential

getSafeWorkingDir

getSafeWorkingDir(): string

- Defined in home/vsts/work/1/s/sdk/identity/identity/src/credentials/azureCliCredential.ts:11
Returns string

isErrorResponse

isErrorResponse(errorResponse: any): errorResponse is OAuthErrorResponse

- Defined in home/vsts/work/1/s/sdk/identity/identity/src/client/errors.ts:58
Parameters
- errorResponse: any
Returns errorResponse is OAuthErrorResponse

logEnvVars

logEnvVars(credentialName: string, supportedEnvVars: string[]): void

- Defined in home/vsts/work/1/s/sdk/identity/identity/src/util/logging.ts:42
Based on a given list of environment variable names, logs the environment variables currently assigned during the usage of a credential that goes by the given name.

Parameters
- credentialName: string
  
  Name of the credential in use
- supportedEnvVars: string[]
  
  List of environment variables supported by that credential
Returns void

processEnvVars

processEnvVars(supportedEnvVars: string[]): EnvironmentAccumulator

- Defined in home/vsts/work/1/s/sdk/identity/identity/src/util/logging.ts:22
Separates a list of environment variable names into a plain object with two arrays: an array of missing environment variables and another array with assigned environment variables.

Parameters
- supportedEnvVars: string[]
  
  List of environment variable names
Returns EnvironmentAccumulator

timestampInSeconds

timestampInSeconds(date: Date): number

- Defined in home/vsts/work/1/s/sdk/identity/identity/src/credentials/clientCertificateCredential.ts:18
Parameters
- date: Date
Returns number

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

BrowserLoginStyle

DeviceCodePromptCallback

Type declaration

Parameters

deviceCodeInfo: DeviceCodeInfo

Returns void

Variables

Const AggregateAuthenticationErrorName

Const AllSupportedEnvironmentVariables

Const AppServiceMsiApiVersion

Const AuthenticationErrorName

Const AzureAccountClientId

Const BrowserNotSupportedError

Const CommonTenantId

Const DefaultAuthorityHost

Const DefaultScopeSuffix

Const ImdsApiVersion

Const ImdsEndpoint

Const SelfSignedJwtLifetimeMins

Const VSCodeUserName

Const logger

Let testFunction

Functions

_setDelayTestFunction

Parameters

Optional func: undefined | ((t: number) => Promise<void>)

Returns void

addMinutes

Parameters

date: Date

minutes: number

Returns Date

convertOAuthErrorResponseToErrorResponse

Parameters

errorBody: OAuthErrorResponse

Returns ErrorResponse

createSpan

Parameters

operationName: string

Default value options: GetTokenOptions = {}

Returns { options: GetTokenOptions; span: Span }

options: GetTokenOptions

span: Span

credentialLogger

Parameters

title: string

Default value log: AzureLogger = logger

Returns CredentialLogger

credentialLoggerInstance

Parameters

title: string

Optional parent: CredentialLoggerInstance

Default value log: AzureLogger = logger

Returns CredentialLoggerInstance

delay

Parameters

t: number

Returns Promise<void>

formatError

Parameters

error: Error | string

Returns string

formatSuccess

Parameters

scope: string | string[]

Returns string

getAuthorityHostEnvironment

Returns undefined | { authorityHost: any }

getDefaultAzureCredential

Returns TokenCredential

getSafeWorkingDir

Returns string