Module @ovotech/laminar-jwt

Type aliases

VerifyJWTData

VerifyJWTData<TUser>: (data: JWTData, scopes?: string[]) => Security<TUser>

Type parameters

TUser: User = User

Type declaration

- (data: JWTData, scopes?: string[]): Security<TUser>
- Parameters
  - data: JWTData
  - Optional scopes: string[]
  Returns Security<TUser>

Functions

Const authMiddleware

authMiddleware(options: JWTVerify<User>): (scopes?: string[]) => HttpMiddleware<RequestAuthInfo<User>, Empty>

- Defined in packages/laminar-jwt/src/jwt.ts:108
Parameters
- options: JWTVerify<User>
Returns (scopes?: string[]) => HttpMiddleware<RequestAuthInfo<User>, Empty>
- - (scopes?: string[]): HttpMiddleware<RequestAuthInfo<User>, Empty>
  - Parameters
    - Optional scopes: string[]
    Returns HttpMiddleware<RequestAuthInfo<User>, Empty>

Const createSession

createSession<TUser>(__namedParameters: JWTSign, user: TUser): Session<TUser>

- Defined in packages/laminar-jwt/src/jwt.ts:39
Type parameters
- TUser: User = User
Parameters
- __namedParameters: JWTSign
- user: TUser
Returns Session<TUser>

Const createSessionMiddleware

createSessionMiddleware(options: JWTSign): Middleware<RequestSign<User>, Empty>

- Defined in packages/laminar-jwt/src/jwt.ts:126
Parameters
- options: JWTSign
Returns Middleware<RequestSign<User>, Empty>

Const jwkPublicKey

jwkPublicKey(__namedParameters: JWKHandlerOptions): GetPublicKeyOrSecret

- Defined in packages/laminar-jwt/src/jwk.ts:46
Parameters
- __namedParameters: JWKHandlerOptions
Returns GetPublicKeyOrSecret

Const jwtSecurityResolver

jwtSecurityResolver<TUser>(options: JWTVerify<TUser>): OapiSecurityResolver<Empty, TUser>

- Defined in packages/laminar-jwt/src/jwt.ts:121
Type parameters
- TUser: User = User
Parameters
- options: JWTVerify<TUser>
Returns OapiSecurityResolver<Empty, TUser>

Const keycloakAuthMiddleware

keycloakAuthMiddleware(options: KeycloakOptions): (scopes?: string[]) => HttpMiddleware<RequestAuthInfo<User>, Empty>

- Defined in packages/laminar-jwt/src/keycloak.ts:36
Parameters
- options: KeycloakOptions
Returns (scopes?: string[]) => HttpMiddleware<RequestAuthInfo<User>, Empty>
- - (scopes?: string[]): HttpMiddleware<RequestAuthInfo<User>, Empty>
  - Parameters
    - Optional scopes: string[]
    Returns HttpMiddleware<RequestAuthInfo<User>, Empty>

Const keycloakJwtSecurityResolver

keycloakJwtSecurityResolver(options: KeycloakOptions): OapiSecurityResolver<Empty, User>

- Defined in packages/laminar-jwt/src/keycloak.ts:41
Parameters
- options: KeycloakOptions
Returns OapiSecurityResolver<Empty, User>

Const verifyBearer

verifyBearer<TUser>(options: JWTVerify<TUser>, authorization?: string, scopes?: string[]): Promise<Security<TUser>>

- Defined in packages/laminar-jwt/src/jwt.ts:92
Type parameters
- TUser: User
Parameters
- options: JWTVerify<TUser>
- Optional authorization: string
- Optional scopes: string[]
Returns Promise<Security<TUser>>

Const verifyJWT

verifyJWT<TUser>(data: JWTData, scopes?: string[]): Security<TUser>

- Defined in packages/laminar-jwt/src/jwt.ts:23
Type parameters
- TUser: User = User
Parameters
- data: JWTData
- scopes: string[] = []
Returns Security<TUser>

Const verifyKeycloack

verifyKeycloack(service: string): VerifyJWTData<User>

- Defined in packages/laminar-jwt/src/keycloak.ts:18
Parameters
- service: string
Returns VerifyJWTData<User>

Const verifyToken

verifyToken<TUser>(__namedParameters: JWTVerify<TUser>, token: string, scopes?: string[]): Promise<Security<TUser>>

- Defined in packages/laminar-jwt/src/jwt.ts:55
Type parameters
- TUser: User
Parameters
- __namedParameters: JWTVerify<TUser>
- token: string
- Optional scopes: string[]
Returns Promise<Security<TUser>>

Generated using TypeDoc