Class EveSsoClient

Minimal client for the EVE SSO OAuth2 endpoints: building the login URL, exchanging an authorization code, refreshing, and revoking.

Supports confidential clients (HTTP Basic with the client secret) and public clients (PKCE with client_id in the body). No JWT signature verification is performed; tokens are trusted because they arrive directly from SSO over TLS. verifyAccessToken checks a token against SSO's JWKS.

Index

Constructors

constructor

new EveSsoClient(config: EveSsoClientConfig): EveSsoClient
Parameters
- config: EveSsoClientConfig
Returns EveSsoClient
- Defined in src/auth/EveSsoClient.ts:131

Accessors

tokenUrl

get tokenUrl(): string
Returns string
- Defined in src/auth/EveSsoClient.ts:164

authorizeUrl

get authorizeUrl(): string
Returns string
- Defined in src/auth/EveSsoClient.ts:168

revokeUrl

get revokeUrl(): string
Returns string
- Defined in src/auth/EveSsoClient.ts:172

Methods

getClientId

getClientId(): string
The application's SSO client id; tokens it obtains carry it in aud.

Returns string
- Defined in src/auth/EveSsoClient.ts:155

isConfidential

isConfidential(): boolean
True when a client secret is configured (confidential client).

Returns boolean
- Defined in src/auth/EveSsoClient.ts:160

getAuthorizationUrl

getAuthorizationUrl(options: AuthorizationUrlOptions): string
Build the URL to send a player to for login.
Parameters
- options: AuthorizationUrlOptions
Returns string
- Defined in src/auth/EveSsoClient.ts:177

exchangeCode

exchangeCode(
code: string,
options?: ExchangeCodeOptions,
): Promise<SsoTokenResponse>
Exchange the authorization code from the callback for tokens.
Parameters
- code: string
- options: ExchangeCodeOptions = {}
Returns Promise<SsoTokenResponse>
- Defined in src/auth/EveSsoClient.ts:198

refresh

refresh(
refreshToken: string,
options?: RefreshOptions,
): Promise<SsoTokenResponse>
Obtain a new access token (and rotated refresh token) from a refresh token.
Parameters
- refreshToken: string
- options: RefreshOptions = {}
Returns Promise<SsoTokenResponse>
- Defined in src/auth/EveSsoClient.ts:219

revoke

revoke(
token: string,
tokenTypeHint?: "access_token" | "refresh_token",
): Promise<void>
Revoke a refresh token so it can no longer be used.
Parameters
- token: string
- tokenTypeHint: "access_token" | "refresh_token" = 'refresh_token'
Returns Promise<void>
- Defined in src/auth/EveSsoClient.ts:234

Class EveSsoClient

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns EveSsoClient

Accessors

tokenUrl

Returns string

authorizeUrl

Returns string

revokeUrl

Returns string

Methods

getClientId

Returns string

isConfidential

Returns boolean

getAuthorizationUrl

Parameters

Returns string

exchangeCode

Parameters

Returns Promise<SsoTokenResponse>

refresh

Parameters

Returns Promise<SsoTokenResponse>

revoke

Parameters

Returns Promise<void>

Settings

On This Page