Apex Developer Guide

Apex Developer Guide
Getting Started with Apex
Writing Apex
Running Apex
Debugging, Testing, and Deploying Apex
Apex Language Reference
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
AuthConfiguration Class
AuthProviderCallbackState Class
AuthProviderPlugin Interface
AuthProviderPluginClass Class
AuthProviderTokenResponse Class
AuthToken Class
CommunitiesUtil Class
ConfigurableSelfRegHandler Interface
ConnectedAppPlugin Class
InvocationContext Enum
JWS Class
JWT Class
JWT Methods
JWTBearerTokenExchange Class
LightningLoginEligibility Enum
LoginDiscoveryHandler Interface
LoginDiscoveryMethod Enum
MyDomainLoginDiscoveryHandler Interface
OAuthRefreshResult Class
RegistrationHandler Interface
SamlJitHandler Interface
SessionManagement Class
SessionLevel Enum
UserData Class
VerificationMethod Enum
VerificationPolicy Enum
VerificationResult Class
Auth Exceptions
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommercePayments Namespace
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
Dom Namespace
EventBus Namespace
Flow Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Site Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
wave Namespace
Appendices
Glossary
PDF

Newer Version Available

This content describes an older version of this product. View Latest

JWT Class

Generates the JSON Claims Set in a JSON Web Token (JWT). The resulting Base64-encoded payload can be passed as an argument to create an instance of the Auth.JWS class.

Namespace

Auth

Usage

Use the methods in this class to generate the payload in a JWT bearer token.

JWT Methods

The following are methods for JWT. All are instance methods.

clone()

Makes a duplicate copy of the JWT object.

Signature

public Object clone()

Return Value

Type: JWT

getAdditionalClaims()

Returns a map of additional claims in the JWT, where the key string contains the name of the claim, and the value contains the value of the claim.

Signature

public Map<String,ANY> getAdditionalClaims()

Return Value

Type: Map<String,ANY>

getAud()

Returns the audience claim that identifies the intended recipients of the JWT.

Signature

public String getAud()

Return Value

Type: String

getIss()

Returns the issuer claim that identifies the issuer of the JWT.

Signature

public String getIss()

Return Value

Type: String

getNbfClockSkew()

Returns the not before claim that identifies the time before which the JWT must not be accepted for processing, while allowing some leeway for clock skew.

Signature

public Integer getNbfClockSkew()

Return Value

Type: Integer

getSub()

Returns the subject claim that identifies the current user of the JWT.

Signature

public String getSub()

Return Value

Type: String

getValidityLength()

Returns the length of time (in seconds) that the JWT is valid, which affects the expiration claim.

Signature

public Integer getValidityLength()

Return Value

Type: Integer

setAdditionalClaims(additionalClaims)

Sets the additional claims in the JWT. Returned by the getAdditionalClaims() method.

Signature

public void setAdditionalClaims(Map<String,ANY> additionalClaims)

Parameters

additionalClaims
Type: Map<String,ANY>

Return Value

Type: void

Usage

Additional claims must not include any standard claims.

setAud(aud)

Sets the audience claim in the JWT. Returned by the getAud() method.

Signature

public void setAud(String aud)

Parameters

aud
Type: String

Return Value

Type: void

setIss(iss)

Sets the issuer claim in the JWT. Returned by the getIss() method.

Signature

public void setIss(String iss)

Parameters

iss
Type: String

Return Value

Type: void

setNbfClockSkew(nbfClockSkew)

Sets the not before claim in the JWT. Returned by the getNbfClockSkew() method.

Signature

public void setNbfClockSkew(Integer nbfClockSkew)

Parameters

nbfClockSkew
Type: Integer

Return Value

Type: void

setSub(sub)

Sets the subject claim in the JWT. Returned by the getSub() method.

Signature

public void setSub(String sub)

Parameters

sub
Type: String

Return Value

Type: void

setValidityLength(validityLength)

Sets the length of time (in seconds) that the JWT is valid, which affects the expiration claim. Returned by the getValidityLength() method.

Signature

public void setValidityLength(Integer validityLength)

Parameters

validityLength
Type: Integer

Return Value

Type: void

toJSONString()

Generates the JSON object representation of the Claims Set as an encoded JWT payload.

Signature

public String toJSONString()

Return Value

Type: String