Interface OpenIdConnectConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<OpenIdConnectConfiguration.Builder,
,OpenIdConnectConfiguration> SdkBuilder<OpenIdConnectConfiguration.Builder,
,OpenIdConnectConfiguration> SdkPojo
- Enclosing class:
OpenIdConnectConfiguration
-
Method Summary
Modifier and TypeMethodDescriptionentityIdPrefix
(String entityIdPrefix) A descriptive string that you want to prefix to user entities from your OIDC identity provider.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.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.The issuer URL of an OIDC identity provider.tokenSelection
(Consumer<OpenIdConnectTokenSelection.Builder> tokenSelection) The token type that you want to process from your OIDC identity provider.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, sdkFieldNameToField, sdkFields
-
Method Details
-
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
A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an
entityIdPrefix
ofMyOIDCProvider
, you can reference principals in your policies in the formatMyCorp::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 anentityIdPrefix
ofMyOIDCProvider
, you can reference principals in your policies in the formatMyCorp::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 toMyCorp::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 agroups
claim toMyCorp::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
This is a convenience method that creates an instance of thegroups
claim toMyCorp::UserGroup
.OpenIdConnectGroupConfiguration.Builder
avoiding the need to create one manually viaOpenIdConnectGroupConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed togroupConfiguration(OpenIdConnectGroupConfiguration)
.- Parameters:
groupConfiguration
- a consumer that will call methods onOpenIdConnectGroupConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theOpenIdConnectTokenSelection.Builder
avoiding the need to create one manually viaOpenIdConnectTokenSelection.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totokenSelection(OpenIdConnectTokenSelection)
.- Parameters:
tokenSelection
- a consumer that will call methods onOpenIdConnectTokenSelection.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-