Package software.amazon.awssdk.services.ssoadmin.model

Class OidcJwtConfiguration

java.lang.Object

software.amazon.awssdk.services.ssoadmin.model.OidcJwtConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<OidcJwtConfiguration.Builder,OidcJwtConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class OidcJwtConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<OidcJwtConfiguration.Builder,OidcJwtConfiguration>

A structure that describes configuration settings for a trusted token issuer that supports OpenID Connect (OIDC) and JSON Web Tokens (JWTs).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OidcJwtConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static OidcJwtConfiguration.Builder	builder()
String	claimAttributePath()	The path of the source attribute in the JWT from the trusted token issuer.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	identityStoreAttributePath()	The path of the destination attribute in a JWT from IAM Identity Center.
String	issuerUrl()	The URL that IAM Identity Center uses for OpenID Discovery.
JwksRetrievalOption	jwksRetrievalOption()	The method that the trusted token issuer can use to retrieve the JSON Web Key Set used to verify a JWT.
String	jwksRetrievalOptionAsString()	The method that the trusted token issuer can use to retrieve the JSON Web Key Set used to verify a JWT.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends OidcJwtConfiguration.Builder>	serializableBuilderClass()
OidcJwtConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

claimAttributePath

public final String claimAttributePath()

The path of the source attribute in the JWT from the trusted token issuer. The attribute mapped by this JMESPath expression is compared against the attribute mapped by IdentityStoreAttributePath when a trusted token issuer token is exchanged for an IAM Identity Center token.

Returns:

The path of the source attribute in the JWT from the trusted token issuer. The attribute mapped by this JMESPath expression is compared against the attribute mapped by IdentityStoreAttributePath when a trusted token issuer token is exchanged for an IAM Identity Center token.

identityStoreAttributePath

public final String identityStoreAttributePath()

The path of the destination attribute in a JWT from IAM Identity Center. The attribute mapped by this JMESPath expression is compared against the attribute mapped by ClaimAttributePath when a trusted token issuer token is exchanged for an IAM Identity Center token.

Returns:

The path of the destination attribute in a JWT from IAM Identity Center. The attribute mapped by this JMESPath expression is compared against the attribute mapped by ClaimAttributePath when a trusted token issuer token is exchanged for an IAM Identity Center token.

issuerUrl

public final String issuerUrl()

The URL that IAM Identity Center uses for OpenID Discovery. OpenID Discovery is used to obtain the information required to verify the tokens that the trusted token issuer generates.

Returns:

The URL that IAM Identity Center uses for OpenID Discovery. OpenID Discovery is used to obtain the information required to verify the tokens that the trusted token issuer generates.

jwksRetrievalOption

public final JwksRetrievalOption jwksRetrievalOption()

The method that the trusted token issuer can use to retrieve the JSON Web Key Set used to verify a JWT.

If the service returns an enum value that is not available in the current SDK version, jwksRetrievalOption will return JwksRetrievalOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jwksRetrievalOptionAsString().

Returns:

The method that the trusted token issuer can use to retrieve the JSON Web Key Set used to verify a JWT.

See Also:

JwksRetrievalOption

jwksRetrievalOptionAsString

public final String jwksRetrievalOptionAsString()

The method that the trusted token issuer can use to retrieve the JSON Web Key Set used to verify a JWT.

If the service returns an enum value that is not available in the current SDK version, jwksRetrievalOption will return JwksRetrievalOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jwksRetrievalOptionAsString().

Returns:

The method that the trusted token issuer can use to retrieve the JSON Web Key Set used to verify a JWT.

See Also:

JwksRetrievalOption

toBuilder

public OidcJwtConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OidcJwtConfiguration.Builder,OidcJwtConfiguration>

builder

public static OidcJwtConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends OidcJwtConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo