Package software.amazon.awssdk.services.verifiedpermissions.model

Class OpenIdConnectAccessTokenConfigurationItem

java.lang.Object

software.amazon.awssdk.services.verifiedpermissions.model.OpenIdConnectAccessTokenConfigurationItem

All Implemented Interfaces:

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

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

The configuration of an OpenID Connect (OIDC) identity source for handling access token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the aud claim, or audiences, that you want to accept.

This data type is part of a OpenIdConnectTokenSelectionItem structure, which is a parameter of ListIdentitySources.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OpenIdConnectAccessTokenConfigurationItem.Builder

Method Summary

Modifier and Type	Method	Description
List<String>	audiences()	The access token aud claim values that you want to accept in your policy store.
static OpenIdConnectAccessTokenConfigurationItem.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAudiences()	For responses, this returns true if the service returned a value for the Audiences property.
int	hashCode()
String	principalIdClaim()	The claim that determines the principal in OIDC access tokens.
List<SdkField<?>>	sdkFields()
static Class<? extends OpenIdConnectAccessTokenConfigurationItem.Builder>	serializableBuilderClass()
OpenIdConnectAccessTokenConfigurationItem.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

principalIdClaim

public final String principalIdClaim()

The claim that determines the principal in OIDC access tokens. For example, sub.

Returns:

The claim that determines the principal in OIDC access tokens. For example, sub.

hasAudiences

public final boolean hasAudiences()

For responses, this returns true if the service returned a value for the Audiences property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

audiences

public final List<String> audiences()

The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAudiences() method.

Returns:

The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.

toBuilder

public OpenIdConnectAccessTokenConfigurationItem.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OpenIdConnectAccessTokenConfigurationItem.Builder,OpenIdConnectAccessTokenConfigurationItem>

builder

public static OpenIdConnectAccessTokenConfigurationItem.Builder builder()

serializableBuilderClass

public static Class<? extends OpenIdConnectAccessTokenConfigurationItem.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