UpdateOpenIdConnectConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.verifiedpermissions.model.UpdateOpenIdConnectConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateOpenIdConnectConfiguration
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 UpdateConfiguration structure, which is a parameter to UpdateIdentitySource.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

UpdateOpenIdConnectConfiguration()

Constructors
Constructor and Description
`UpdateOpenIdConnectConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UpdateOpenIdConnectConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getEntityIdPrefix()` A descriptive string that you want to prefix to user entities from your OIDC identity provider.
`UpdateOpenIdConnectGroupConfiguration`	`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.
`UpdateOpenIdConnectTokenSelection`	`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(UpdateOpenIdConnectGroupConfiguration 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(UpdateOpenIdConnectTokenSelection tokenSelection)` The token type that you want to process from your OIDC identity provider.
`String`	`toString()` Returns a string representation of this object.
`UpdateOpenIdConnectConfiguration`	`withEntityIdPrefix(String entityIdPrefix)` A descriptive string that you want to prefix to user entities from your OIDC identity provider.
`UpdateOpenIdConnectConfiguration`	`withGroupConfiguration(UpdateOpenIdConnectGroupConfiguration 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.
`UpdateOpenIdConnectConfiguration`	`withIssuer(String issuer)` The issuer URL of an OIDC identity provider.
`UpdateOpenIdConnectConfiguration`	`withTokenSelection(UpdateOpenIdConnectTokenSelection tokenSelection)` The token type that you want to process from your OIDC identity provider.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UpdateOpenIdConnectConfiguration
```
public UpdateOpenIdConnectConfiguration()
```
- Method Detail
  - setIssuer
```
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.
    
    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.
  - getIssuer
```
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.
    
    Returns:
    
    The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration.
  - withIssuer
```
public UpdateOpenIdConnectConfiguration 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.
    
    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.
  - setEntityIdPrefix
```
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.
    
    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.
  - getEntityIdPrefix
```
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.
    
    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.
  - withEntityIdPrefix
```
public UpdateOpenIdConnectConfiguration 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.
    
    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.
  - setGroupConfiguration
```
public void setGroupConfiguration(UpdateOpenIdConnectGroupConfiguration 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.
  - getGroupConfiguration
```
public UpdateOpenIdConnectGroupConfiguration 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.
    
    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.
  - withGroupConfiguration
```
public UpdateOpenIdConnectConfiguration withGroupConfiguration(UpdateOpenIdConnectGroupConfiguration 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.
  - setTokenSelection
```
public void setTokenSelection(UpdateOpenIdConnectTokenSelection 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.
  - getTokenSelection
```
public UpdateOpenIdConnectTokenSelection 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.
    
    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.
  - withTokenSelection
```
public UpdateOpenIdConnectConfiguration withTokenSelection(UpdateOpenIdConnectTokenSelection 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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public UpdateOpenIdConnectConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.779

Class UpdateOpenIdConnectConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UpdateOpenIdConnectConfiguration

Method Detail

setIssuer

getIssuer

withIssuer

setEntityIdPrefix

getEntityIdPrefix

withEntityIdPrefix

setGroupConfiguration

getGroupConfiguration

withGroupConfiguration

setTokenSelection

getTokenSelection

withTokenSelection

toString

equals

hashCode

clone

marshall