Module health.base.auth
ballerinax/health.base.auth Ballerina library
1.0.3
Private Key JWT Authentication Provider
Module Overview
This module contains an authentication provider that supports client assertion JWTs. Using this module, access token requests to token endpoints can be sent with a client assertion. The module handles also the caching and management of access tokens.
Classes
health.base.auth: PKJWTAuthProvider
Isolated
Class that generates and manages the access tokens.
getToken
Isolated Function
function getToken() returns string|HealthcareSecurityErrorClients
health.base.auth: PKJWTAuthHandler
Isolated
Client class that handles calling the auth provider and enriching the request.
enrich
Isolated FunctionRemote Function
function enrich(Request req) returns Request|HealthcareSecurityErrorAdd the OAuth2 token to the request.
Parameters
- req Request - The request to be enriched with the OAuth2 token.
Return Type
- Request|HealthcareSecurityError - The request enriched with the OAuth2 token or an error if the token could not be retrieved.
enrichHeaders
Isolated Function
function enrichHeaders(map<string> headers) returns map<string>|HealthcareSecurityErrorAdd the OAuth2 token to the headers.
Return Type
- map<string>|HealthcareSecurityError - The headers enriched with the OAuth2 token or an error if the token could not be retrieved.
Records
health.base.auth: PKJWTAuthConfig
Closed record
Configs required to generate the client assertion JWT
Fields
- clientId string - Client ID provided by the token endpoint
- tokenEndpoint string - Token endpoint
- keyFile string - Path to private key //todo: add support to accept key store as well
- defaultTokenExpTime int(default 3600) - Expiration time (in seconds) of the tokens if the token endpoint response does not contain an
expires_infield
- clockSkew decimal(default 0) - Clock skew (in seconds) that can be used to avoid token validation failures due to clock synchronization problems
Simple name reference types
health.base.auth: HealthcareSecurityError
HealthcareSecurityError
Auth module error