Package dev.getelements.elements.sdk.model.auth

Enum Class OidcClaim

java.lang.Object

java.lang.Enum<OidcClaim>

dev.getelements.elements.sdk.model.auth.OidcClaim

All Implemented Interfaces:

Serializable, Comparable<OidcClaim>, Constable

public enum OidcClaim
extends Enum<OidcClaim>

Enumeration of the claims elements uses when processing OIDC JWT tokens.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUD	Audience - the client or application id.
EXP	Expiry - Access is disallowed after this time
IAT	Issued at
ISS	Issuer - the issuer of the token.
KID	Key Identifier
NBF	Not before - Access is disallowed before this time
SUB	Subject - A user or request id

Method Summary

Modifier and Type	Method	Description
String	getValue()	Gets the literal value of the claim.
static OidcClaim	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OidcClaim[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

KID

public static final OidcClaim KID

Key Identifier

SUB

public static final OidcClaim SUB

Subject - A user or request id

AUD

public static final OidcClaim AUD

Audience - the client or application id. May be required for OAUTH2.

ISS

public static final OidcClaim ISS

Issuer - the issuer of the token. Typically, a URL containing the issuer's domain.

EXP

public static final OidcClaim EXP

Expiry - Access is disallowed after this time

NBF

public static final OidcClaim NBF

Not before - Access is disallowed before this time

IAT

public static final OidcClaim IAT

Issued at

Method Details

values

public static OidcClaim[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static OidcClaim valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

Gets the literal value of the claim.

Returns:

the literal value