Interface Claims

api/src/main/java/io/jsonwebtoken/Claims.java:40–166

A JWT Claims set . This is an immutable JSON map with convenient type-safe getters for JWT standard claim names. Additionally, this interface also extends Map<String, Object> , so you can use standard {@

 * @since 0.1
 */
public interface Claims extends Map<String, Object>, Identifiable {

    /**
     * JWT {@code Issuer} claims parameter name: <code>"iss"</code>
     */
    String ISSUER = "iss";

    /**
     * JWT {@code Subject} claims parameter name: <code>"sub"</code>
     */
    String SUBJECT = "sub";

    /**
     * JWT {@code Audience} claims parameter name: <code>"aud"</code>
     */
    String AUDIENCE = "aud";

    /**
     * JWT {@code Expiration} claims parameter name: <code>"exp"</code>
     */
    String EXPIRATION = "exp";

    /**
     * JWT {@code Not Before} claims parameter name: <code>"nbf"</code>
     */
    String NOT_BEFORE = "nbf";

    /**
     * JWT {@code Issued At} claims parameter name: <code>"iat"</code>
     */
    String ISSUED_AT = "iat";

    /**
     * JWT {@code JWT ID} claims parameter name: <code>"jti"</code>
     */
    String ID = "jti";

    /**
     * Returns the JWT <a href="https://www.rfc-editor.org/rfc/rfc7519.html#section-4.1.1">
     * <code>iss</code></a> (issuer) value or {@code null} if not present.
     *
     * @return the JWT {@code iss} value or {@code null} if not present.
     */
    String getIssuer();

    /**
     * Returns the JWT <a href="https://www.rfc-editor.org/rfc/rfc7519.html#section-4.1.2">
     * <code>sub</code></a> (subject) value or {@code null} if not present.
     *
     * @return the JWT {@code sub} value or {@code null} if not present.
     */
    String getSubject();

    /**
     * Returns the JWT <a href="https://www.rfc-editor.org/rfc/rfc7519.html#section-4.1.3">
     * <code>aud</code></a> (audience) value or {@code null} if not present.
     *
     * @return the JWT {@code aud} value or {@code null} if not present.