1. Epic GamesDeveloper
  3. FJsonWebToken

FJsonWebToken

API > API/Plugins > API/Plugins/JWT

References

   
Module JWT
Header /Engine/Plugins/Experimental/JWT/Source/JWT/Public/JsonWebToken.h
Include #include "JsonWebToken.h"

Syntax

class FJsonWebToken

Constructors

No constructors are accessible with public or protected access.

Functions

  Type Name Description
Public function Static bool

FromString ( const FStringView InEncodedJsonWebToken,
FJsonWebToken& OutJsonWebToken
)

  
Public function Static TOptional< FJsonWebToken >

FromString ( const FStringView InEncodedJsonWebToken
)

 Creates a JWT from the provided string.
Public function Const bool

GetAlgorithm ( FString& OutValue
)

 Gets the algorithm that was used to construct the signature.
Public function Const bool

GetAudience ( FString& OutValue
)

 Gets the audience.
Public function Const bool

GetClaim ( const FStringView InName,
TSharedPtr< FJsonValue >& OutClaim
)

 Gets a claim by name.
Public function Const TSharedPtr< FJsonValue >

GetClaim ( const FStringView InName
)

 Gets a claim by name.
Public function Const bool

GetExpiration ( int64& OutValue
)

 Gets the expiration timestamp.
Public function Const bool

GetIssuedAt ( int64& OutValue
)

 Gets the issued at timestamp.
Public function Const bool

GetIssuer ( FString& OutValue
)

 Gets the issuer domain.
Public function Const bool

GetKeyId ( FString& OutValue
)

 Gets the key id.
Public function Const bool

GetNotBefore ( int64& OutValue
)

 Gets the not valid before timestamp.
Public function Const const TSharedRef< FJsonObject > & Get raw JSON object for payload, allowing for custom claim parsing with FJsonSerializable classes.
Public function Const bool

GetStringClaim ( const FString& InName,
FString& OutValue
)

 Get a custom claim by name.
Public function Const bool

GetSubject ( FString& OutValue
)

 Gets the subject.
Public function Const bool

GetType ( FString& OutValue
)

 Gets the type.
Public function Const bool Checks whether the tokens expiration timestamp is in the past.
Public function Const bool

Verify ()

 Deprecated method to signature validate the JWT.
Public function Const bool

Verify ( const IJwtAlgorithm& Algorithm,
const FStringView ExpectedIssuer
)

 Signature validate and verify the JWT.

Constants

Name Description
CLAIM_AUDIENCE  
CLAIM_EXPIRATION  
CLAIM_ISSUED_AT  
CLAIM_ISSUER JWT payload registered claim field names.
CLAIM_NOT_BEFORE  
CLAIM_SUBJECT  
HEADER_ALGORITHM  
HEADER_KEY_ID  
HEADER_TYPE JWT header field names.
TYPE_VALUE_JWT JWT header expected values.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page