Skip to main content

Interface: AuthResult

Defined in: service-core/src/auth/AuthStrategy.ts:10

Result returned by AuthStrategy.authenticate().

Extended by

Properties

data?

optional data?: any

Defined in: service-core/src/auth/AuthStrategy.ts:12

The raw auth data that was verified.


method

method: string

Defined in: service-core/src/auth/AuthStrategy.ts:14

The name of the auth strategy that produced this result.


payload?

optional payload?: any

Defined in: service-core/src/auth/AuthStrategy.ts:16

The fully decoded payload from the auth data.


state?

optional state?: string

Defined in: service-core/src/auth/AuthStrategy.ts:21

Client-supplied app-correlation data extracted from the state round-trip, if any (see OAuthStrategy's combined state/CSRF design). Available to route handlers via @AuthResult.


user?

optional user?: JWTUser

Defined in: service-core/src/auth/AuthStrategy.ts:23

The authenticated user profile, or undefined if authentication failed.