Interface TokenCredentials

Combines TokenProvider and Credentials interfaces.

interface TokenCredentials {
    authHeaders(): Promise<Header[]>;
    name(): string;
    token(): Promise<Token>;
}

Hierarchy (View Summary)

TokenProvider
Credentials
- TokenCredentials

Index

Methods

authHeaders name token

Methods

authHeaders

authHeaders(): Promise<Header[]>
Returns headers to authenticate requests.

Returns Promise<Header[]>
Inherited from Credentials.authHeaders
- Defined in packages/auth/src/auth.ts:31

name

name(): string
Short identifier for the authentication strategy, e.g. pat or oauth-m2m. Used for logging and for selecting between strategies.

Returns string
Inherited from Credentials.name
- Defined in packages/auth/src/auth.ts:26

token

token(): Promise<Token>
Returns a token or throws an error. The returned Token should be considered immutable and should not be modified.

Returns Promise<Token>
Inherited from TokenProvider.token
- Defined in packages/auth/src/auth.ts:66