com.amazonaws.services.verifiedpermissions.model

Class UpdateOpenIdConnectAccessTokenConfiguration

java.lang.Object

com.amazonaws.services.verifiedpermissions.model.UpdateOpenIdConnectAccessTokenConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

The configuration of an OpenID Connect (OIDC) identity source for handling access 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 UpdateOpenIdConnectTokenSelection structure, which is a parameter to UpdateIdentitySource.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
UpdateOpenIdConnectAccessTokenConfiguration()

Method Summary

Modifier and Type	Method and Description
UpdateOpenIdConnectAccessTokenConfiguration	clone()
boolean	equals(Object obj)
List<String>	getAudiences() The access token aud claim values that you want to accept in your policy store.
String	getPrincipalIdClaim() The claim that determines the principal in OIDC access tokens.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAudiences(Collection<String> audiences) The access token aud claim values that you want to accept in your policy store.
void	setPrincipalIdClaim(String principalIdClaim) The claim that determines the principal in OIDC access tokens.
String	toString() Returns a string representation of this object.
UpdateOpenIdConnectAccessTokenConfiguration	withAudiences(Collection<String> audiences) The access token aud claim values that you want to accept in your policy store.
UpdateOpenIdConnectAccessTokenConfiguration	withAudiences(String... audiences) The access token aud claim values that you want to accept in your policy store.
UpdateOpenIdConnectAccessTokenConfiguration	withPrincipalIdClaim(String principalIdClaim) The claim that determines the principal in OIDC access tokens.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateOpenIdConnectAccessTokenConfiguration

public UpdateOpenIdConnectAccessTokenConfiguration()

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 UpdateOpenIdConnectAccessTokenConfiguration 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.

getAudiences

public List<String> getAudiences()

The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.

Returns:

The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.

setAudiences

public void setAudiences(Collection<String> audiences)

The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.

Parameters:

audiences - The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.

withAudiences

public UpdateOpenIdConnectAccessTokenConfiguration withAudiences(String... audiences)

The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.

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

Parameters:

audiences - The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.

Returns:

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

withAudiences

public UpdateOpenIdConnectAccessTokenConfiguration withAudiences(Collection<String> audiences)

The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.

Parameters:

audiences - The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.

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 UpdateOpenIdConnectAccessTokenConfiguration 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.