Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions ballerina/jwt_commons.bal
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,10 @@ const string IAT = "iat";

# Represents JWT header.
#
# + alg - Cryptographic algorithm used to secure the JWS
# + alg - Cryptographic algorithm used to secure the JWS. Supported values: `RS256`, `RS384`, `RS512`, `HS256`, `HS384`, `HS512`, `NONE`.
# + typ - Media type of the JWT
# + cty - Content type, convey structural information about the JWT
# + kid - Key ID, hint indicating which key was used to secure the JWS
# + cty - Content type, conveys structural information about the JWT
# + kid - Key ID, a hint indicating which key was used to secure the JWS
public type Header record {
SigningAlgorithm alg?;
string typ?;
Expand All @@ -74,9 +74,9 @@ public type Header record {
# + sub - Subject, identifies the principal that is the subject of the JWT
# + aud - Audience, identifies the recipients that the JWT is intended for
# + jti - JWT ID, unique identifier for the JWT
# + exp - Expiration time, identifies the expiration time (seconds since the Epoch) on or after which the JWT must not be accepted
# + nbf - Not before, identifies the time (seconds since the Epoch) before which the JWT must not be accepted
# + iat - Issued at, identifies the time (seconds since the Epoch) at which the JWT was issued
# + exp - Expiration time, identifies the expiration time (in seconds since the Epoch) on or after which the JWT must not be accepted
# + nbf - Not before, identifies the time (in seconds since the Epoch) before which the JWT must not be accepted
# + iat - Issued at, identifies the time (in seconds since the Epoch) at which the JWT was issued
public type Payload record {
string iss?;
string sub?;
Expand Down
2 changes: 1 addition & 1 deletion ballerina/listener_jwt_auth_provider.bal
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ public isolated class ListenerJwtAuthProvider {
self.jwksCache = ();
}

# Authenticates the provided JWT.
# Authenticates the provided JWT against the configured validator.
#```ballerina
# boolean result = check provider.authenticate("<credential>");
# ```
Expand Down
Loading