Payload (IG Aggregated Javadoc 2023.11.0 Documentation)

All Known Implementing Classes:

EncryptedJwt, EncryptedThenSignedJwt, JwtClaimsSet, SignedEncryptedJwt, SignedJwt, SignedThenEncryptedJwt
```
public interface Payload
```
The interface represents the body of a JWT.
When the JWT is digitally signed or MACed, the bytes of the UTF-8 representation of the Payload are base64url encoded to create the Encoded JWS Payload. When the JWT is encrypted, the bytes of the UTF-8 representation of the Payload are used as the JWE Plaintext.

Since:

2.0.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`build()`	Builds the JWTs Payload into a `String` by following the steps specified in the relevant specification according to whether the JWT is being signed and/or encrypted.
`Payload`	`copy()`	Create a copy of the current payload.

- Method Detail
  - build
```
String build()
```
    Builds the JWTs Payload into a String by following the steps specified in the relevant specification according to whether the JWT is being signed and/or encrypted.
    
    Returns:
    
    The base64url encoded UTF-8 representation of the JWTs Payload.
    
    See Also:
    
    JSON Web Token Specification, JSON Web Signature Specification, JSON Web Encryption Specification
  - copy
```
Payload copy()
```
    Create a copy of the current payload.
    
    Returns:
    
    a copy of the payload.