@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class OpenIdConnectConfigurationItem extends Object implements Serializable, Cloneable, StructuredPojo
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 ConfigurationItem structure, which is a parameter to ListIdentitySources.
Constructor and Description |
---|
OpenIdConnectConfigurationItem() |
Modifier and Type | Method and Description |
---|---|
OpenIdConnectConfigurationItem |
clone() |
boolean |
equals(Object obj) |
String |
getEntityIdPrefix()
A descriptive string that you want to prefix to user entities from your OIDC identity provider.
|
OpenIdConnectGroupConfigurationItem |
getGroupConfiguration()
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.
|
String |
getIssuer()
The issuer URL of an OIDC identity provider.
|
OpenIdConnectTokenSelectionItem |
getTokenSelection()
The token type that you want to process from your OIDC identity provider.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setEntityIdPrefix(String entityIdPrefix)
A descriptive string that you want to prefix to user entities from your OIDC identity provider.
|
void |
setGroupConfiguration(OpenIdConnectGroupConfigurationItem 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.
|
void |
setIssuer(String issuer)
The issuer URL of an OIDC identity provider.
|
void |
setTokenSelection(OpenIdConnectTokenSelectionItem tokenSelection)
The token type that you want to process from your OIDC identity provider.
|
String |
toString()
Returns a string representation of this object.
|
OpenIdConnectConfigurationItem |
withEntityIdPrefix(String entityIdPrefix)
A descriptive string that you want to prefix to user entities from your OIDC identity provider.
|
OpenIdConnectConfigurationItem |
withGroupConfiguration(OpenIdConnectGroupConfigurationItem 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.
|
OpenIdConnectConfigurationItem |
withIssuer(String issuer)
The issuer URL of an OIDC identity provider.
|
OpenIdConnectConfigurationItem |
withTokenSelection(OpenIdConnectTokenSelectionItem tokenSelection)
The token type that you want to process from your OIDC identity provider.
|
public void setIssuer(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
.
issuer
- The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path
.well-known/openid-configuration
.public String getIssuer()
The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path
.well-known/openid-configuration
.
.well-known/openid-configuration
.public OpenIdConnectConfigurationItem withIssuer(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
.
issuer
- The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path
.well-known/openid-configuration
.public void setEntityIdPrefix(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
.
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
.public String getEntityIdPrefix()
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
.
entityIdPrefix
of MyOIDCProvider
, you can reference
principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos
.public OpenIdConnectConfigurationItem withEntityIdPrefix(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
.
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
.public void setGroupConfiguration(OpenIdConnectGroupConfigurationItem 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
.
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
.public OpenIdConnectGroupConfigurationItem getGroupConfiguration()
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
.
groups
claim
to MyCorp::UserGroup
.public OpenIdConnectConfigurationItem withGroupConfiguration(OpenIdConnectGroupConfigurationItem 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
.
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
.public void setTokenSelection(OpenIdConnectTokenSelectionItem 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.
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.public OpenIdConnectTokenSelectionItem getTokenSelection()
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.
public OpenIdConnectConfigurationItem withTokenSelection(OpenIdConnectTokenSelectionItem 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.
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.public String toString()
toString
in class Object
Object.toString()
public OpenIdConnectConfigurationItem clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.