com.amazonaws.services.verifiedpermissions.model

Class OpenIdConnectIdentityTokenConfiguration

java.lang.Object

com.amazonaws.services.verifiedpermissions.model.OpenIdConnectIdentityTokenConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class OpenIdConnectIdentityTokenConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID) token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the aud claim, or audiences, that you want to accept.

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
OpenIdConnectIdentityTokenConfiguration()

Method Summary

Modifier and Type	Method and Description
OpenIdConnectIdentityTokenConfiguration	clone()
boolean	equals(Object obj)
List<String>	getClientIds() The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider.
String	getPrincipalIdClaim() The claim that determines the principal in OIDC access tokens.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setClientIds(Collection<String> clientIds) The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider.
void	setPrincipalIdClaim(String principalIdClaim) The claim that determines the principal in OIDC access tokens.
String	toString() Returns a string representation of this object.
OpenIdConnectIdentityTokenConfiguration	withClientIds(Collection<String> clientIds) The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider.
OpenIdConnectIdentityTokenConfiguration	withClientIds(String... clientIds) The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider.
OpenIdConnectIdentityTokenConfiguration	withPrincipalIdClaim(String principalIdClaim) The claim that determines the principal in OIDC access tokens.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OpenIdConnectIdentityTokenConfiguration

public OpenIdConnectIdentityTokenConfiguration()

Method Detail

setPrincipalIdClaim

public void setPrincipalIdClaim(String principalIdClaim)

The claim that determines the principal in OIDC access tokens. For example, sub.

Parameters:

principalIdClaim - The claim that determines the principal in OIDC access tokens. For example, sub.

getPrincipalIdClaim

public String getPrincipalIdClaim()

The claim that determines the principal in OIDC access tokens. For example, sub.

Returns:

The claim that determines the principal in OIDC access tokens. For example, sub.

withPrincipalIdClaim

public OpenIdConnectIdentityTokenConfiguration withPrincipalIdClaim(String principalIdClaim)

The claim that determines the principal in OIDC access tokens. For example, sub.

Parameters:

principalIdClaim - The claim that determines the principal in OIDC access tokens. For example, sub.

Returns:

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

getClientIds

public List<String> getClientIds()

The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, 1example23456789, 2example10111213.

Returns:

The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, 1example23456789, 2example10111213.

setClientIds

public void setClientIds(Collection<String> clientIds)

The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, 1example23456789, 2example10111213.

Parameters:

clientIds - The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, 1example23456789, 2example10111213.

withClientIds

public OpenIdConnectIdentityTokenConfiguration withClientIds(String... clientIds)

The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, 1example23456789, 2example10111213.

NOTE: This method appends the values to the existing list (if any). Use setClientIds(java.util.Collection) or withClientIds(java.util.Collection) if you want to override the existing values.

Parameters:

clientIds - The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, 1example23456789, 2example10111213.

Returns:

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

withClientIds

public OpenIdConnectIdentityTokenConfiguration withClientIds(Collection<String> clientIds)

The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, 1example23456789, 2example10111213.

Parameters:

clientIds - The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, 1example23456789, 2example10111213.

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 OpenIdConnectIdentityTokenConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo