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

Class OpenIdConnectConfiguration

java.lang.Object

software.amazon.awssdk.services.verifiedpermissions.model.OpenIdConnectConfiguration

All Implemented Interfaces:

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

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

Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.

This data type is part of a Configuration structure, which is a parameter to CreateIdentitySource.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OpenIdConnectConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static OpenIdConnectConfiguration.Builder	builder()
String	entityIdPrefix()	A descriptive string that you want to prefix to user entities from your OIDC identity provider.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
OpenIdConnectGroupConfiguration	groupConfiguration()	The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to.
int	hashCode()
String	issuer()	The issuer URL of an OIDC identity provider.
List<SdkField<?>>	sdkFields()
static Class<? extends OpenIdConnectConfiguration.Builder>	serializableBuilderClass()
OpenIdConnectConfiguration.Builder	toBuilder()
OpenIdConnectTokenSelection	tokenSelection()	The token type that you want to process from your OIDC identity provider.
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

issuer

public final String issuer()

The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration.

Returns:

The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration.

entityIdPrefix

public final String entityIdPrefix()

A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an entityIdPrefix of MyOIDCProvider, you can reference principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos.

Returns:

A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an entityIdPrefix of MyOIDCProvider, you can reference principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos.

groupConfiguration

public final OpenIdConnectGroupConfiguration groupConfiguration()

The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups claim to MyCorp::UserGroup.

Returns:

The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups claim to MyCorp::UserGroup.

tokenSelection

public final OpenIdConnectTokenSelection tokenSelection()

The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.

Returns:

The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.

toBuilder

public OpenIdConnectConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OpenIdConnectConfiguration.Builder,OpenIdConnectConfiguration>

builder

public static OpenIdConnectConfiguration.Builder builder()

serializableBuilderClass

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