Class TokenAuthenticator

Fetches a token and adds it as an HTTP Authorization: Bearer … value.

The authenticator mutates the supplied gRPC metadata. A fetch error rejects authentication before the RPC starts.

Implements

Authenticator

Indexable

[key: symbol]: () => unknown

Fetches a token and adds it as an HTTP Authorization: Bearer … value.

The authenticator mutates the supplied gRPC metadata. A fetch error rejects authentication before the RPC starts.
- - (): unknown
  - Returns a JSON-safe value for logs.
    
    Returns unknown

Index

Constructors

Properties

Methods

[customJson] authenticate canRetry handleError

Constructors

constructor

new TokenAuthenticator(receiver: Receiver): TokenAuthenticator
Creates an authenticator that fetches tokens from receiver.
Parameters
- receiver: Receiver
Returns TokenAuthenticator
- Defined in src/runtime/authorization/token.ts:32

Properties

`Readonly`$type

$type: "nebius.sdk.TokenAuthenticator" = 'nebius.sdk.TokenAuthenticator'

Contains the fully qualified runtime type name.

Methods

[customJson]

"[customJson]"(): unknown
Returns a JSON-safe value for logs.

Returns unknown
- Defined in src/runtime/authorization/token.ts:25

authenticate

authenticate(
    metadata: Metadata,
    timeoutMs?: number,
    options?: AuthorizationOptions,
): Promise<void>
Adds authorization data to the request metadata.
Parameters
- metadata: Metadata
- OptionaltimeoutMs: number
- Optionaloptions: AuthorizationOptions
Returns Promise<void>
Implementation of Authenticator.authenticate
- Defined in src/runtime/authorization/token.ts:35

canRetry

canRetry(err: unknown, options?: AuthorizationOptions): boolean
Returns whether the retry is allowed.
Parameters
- err: unknown
- Optionaloptions: AuthorizationOptions
Returns boolean
Implementation of Authenticator.canRetry
- Defined in src/runtime/authorization/token.ts:50

handleError

handleError(
    err: unknown,
    options?: AuthorizationOptions,
    timeoutMs?: number,
): Promise<boolean>
Refreshes a rejected credential when the source supports recovery.
Parameters
- err: unknown
- Optionaloptions: AuthorizationOptions
- OptionaltimeoutMs: number
Returns Promise<boolean>
Implementation of Authenticator.handleError
- Defined in src/runtime/authorization/token.ts:46