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

Interface OpenIdConnectConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<OpenIdConnectConfiguration.Builder,OpenIdConnectConfiguration>, SdkBuilder<OpenIdConnectConfiguration.Builder,OpenIdConnectConfiguration>, SdkPojo

Enclosing class:

OpenIdConnectConfiguration

public static interface OpenIdConnectConfiguration.Builder
extends SdkPojo, CopyableBuilder<OpenIdConnectConfiguration.Builder,OpenIdConnectConfiguration>

Method Summary

Modifier and Type	Method	Description
OpenIdConnectConfiguration.Builder	entityIdPrefix(String entityIdPrefix)	A descriptive string that you want to prefix to user entities from your OIDC identity provider.
default OpenIdConnectConfiguration.Builder	groupConfiguration(Consumer<OpenIdConnectGroupConfiguration.Builder> 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.
OpenIdConnectConfiguration.Builder	groupConfiguration(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.
OpenIdConnectConfiguration.Builder	issuer(String issuer)	The issuer URL of an OIDC identity provider.
default OpenIdConnectConfiguration.Builder	tokenSelection(Consumer<OpenIdConnectTokenSelection.Builder> tokenSelection)	The token type that you want to process from your OIDC identity provider.
OpenIdConnectConfiguration.Builder	tokenSelection(OpenIdConnectTokenSelection tokenSelection)	The token type that you want to process from your OIDC identity provider.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

issuer

OpenIdConnectConfiguration.Builder issuer(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

entityIdPrefix

OpenIdConnectConfiguration.Builder entityIdPrefix(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

groupConfiguration

OpenIdConnectConfiguration.Builder groupConfiguration(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

groupConfiguration

default OpenIdConnectConfiguration.Builder groupConfiguration(Consumer<OpenIdConnectGroupConfiguration.Builder> 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.

This is a convenience method that creates an instance of the OpenIdConnectGroupConfiguration.Builder avoiding the need to create one manually via OpenIdConnectGroupConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to groupConfiguration(OpenIdConnectGroupConfiguration).

Parameters:

groupConfiguration - a consumer that will call methods on OpenIdConnectGroupConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

groupConfiguration(OpenIdConnectGroupConfiguration)

tokenSelection

OpenIdConnectConfiguration.Builder tokenSelection(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

tokenSelection

default OpenIdConnectConfiguration.Builder tokenSelection(Consumer<OpenIdConnectTokenSelection.Builder> 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.

This is a convenience method that creates an instance of the OpenIdConnectTokenSelection.Builder avoiding the need to create one manually via OpenIdConnectTokenSelection.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tokenSelection(OpenIdConnectTokenSelection).

Parameters:

tokenSelection - a consumer that will call methods on OpenIdConnectTokenSelection.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

tokenSelection(OpenIdConnectTokenSelection)