Skip to content

@egain/ai-agent-sdk API Reference - v0.1.1 / ClientCredentialsAuthStrategy

Class: ClientCredentialsAuthStrategy

Client credentials authentication strategy for server-side applications Implements OAuth 2.0 client credentials flow

Implements

Table of contents

Constructors

Methods

Constructors

constructor

new ClientCredentialsAuthStrategy(config): ClientCredentialsAuthStrategy

Parameters

NameType
configClientCredentialsAuthConfig

Returns

ClientCredentialsAuthStrategy

Defined in

core/auth/ClientCredentialsAuthStrategy.ts:39

Methods

initialize

initialize(options?): Promise<void>

Initialize the client credentials authentication strategy

Parameters

NameType
options?AuthStrategyInitializeOptions

Returns

Promise<void>

Implementation of

AuthStrategy.initialize

Defined in

core/auth/ClientCredentialsAuthStrategy.ts:44


authenticate

authenticate(): Promise<void>

Authenticate using client credentials flow

Returns

Promise<void>

Implementation of

AuthStrategy.authenticate

Defined in

core/auth/ClientCredentialsAuthStrategy.ts:55


isAuthenticated

isAuthenticated(): boolean

Check if the user is currently authenticated

Returns

boolean

Defined in

core/auth/ClientCredentialsAuthStrategy.ts:71


getToken

getToken(): Promise<string>

Get authentication token using client credentials flow

Returns

Promise<string>

Implementation of

AuthStrategy.getToken

Defined in

core/auth/ClientCredentialsAuthStrategy.ts:80


cleanup

cleanup(): Promise<void>

Cleanup resources

Returns

Promise<void>

Implementation of

AuthStrategy.cleanup

Defined in

core/auth/ClientCredentialsAuthStrategy.ts:111

Released under the MIT License.