Interface IdentitiesClientOptions

interface IdentitiesClientOptions {
    context?: ClientMiddlewareExecutionContext & IdentitiesMiddlewareExecutionContext;
    credentials?: boolean | CredentialProvider | typeof CredentialProvider;
    logger?: Logger;
    prefix?: string;
    retry?: RetryMiddlewareConfiguration;
}

Hierarchy (view full)

  • ClientOptions<IdentitiesMiddlewareExecutionContext>
    • IdentitiesClientOptions

Properties

context? credentials? logger? prefix? retry?

Properties

Optional context

context?: ClientMiddlewareExecutionContext & IdentitiesMiddlewareExecutionContext

The initial middleware execution context

Optional credentials

credentials?: boolean | CredentialProvider | typeof CredentialProvider

A credential provider to use for resolving access tokens. The default credential provider is the ChainedCredentialsProvider. All credential provider inputs may be configured via environmental variables.

Optional logger

logger?: Logger

A logger library compatible with Pino for logging in middleware layers.

Optional prefix

prefix?: string

The environment variable prefix to use to load the credential provider

Optional retry

retry?: RetryMiddlewareConfiguration

Configures the retry middleware. The default configuration will attempt one retry when the response contains a 401 HTTP status code.

Settings

Member Visibility

Theme

On This Page

contextcredentialsloggerprefixretry