com.amazonaws.services.verifiedpermissions.model.OpenIdConnectIdentityTokenConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk-verifiedpermissions Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.verifiedpermissions.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* 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 AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class OpenIdConnectIdentityTokenConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* The claim that determines the principal in OIDC access tokens. For example, sub.
*
*/
private String principalIdClaim;
/**
*
* 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.
*
*/
private java.util.List clientIds;
/**
*
* The claim that determines the principal in OIDC access tokens. For example, sub.
*
*
* @param principalIdClaim
* The claim that determines the principal in OIDC access tokens. For example, sub.
*/
public void setPrincipalIdClaim(String principalIdClaim) {
this.principalIdClaim = principalIdClaim;
}
/**
*
* The claim that determines the principal in OIDC access tokens. For example, sub.
*
*
* @return The claim that determines the principal in OIDC access tokens. For example, sub.
*/
public String getPrincipalIdClaim() {
return this.principalIdClaim;
}
/**
*
* The claim that determines the principal in OIDC access tokens. For example, sub.
*
*
* @param principalIdClaim
* The claim that determines the principal in OIDC access tokens. For example, sub.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OpenIdConnectIdentityTokenConfiguration withPrincipalIdClaim(String principalIdClaim) {
setPrincipalIdClaim(principalIdClaim);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public java.util.List getClientIds() {
return 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.
*
*
* @param 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.
*/
public void setClientIds(java.util.Collection clientIds) {
if (clientIds == null) {
this.clientIds = null;
return;
}
this.clientIds = new java.util.ArrayList(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
* {@link #setClientIds(java.util.Collection)} or {@link #withClientIds(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OpenIdConnectIdentityTokenConfiguration withClientIds(String... clientIds) {
if (this.clientIds == null) {
setClientIds(new java.util.ArrayList(clientIds.length));
}
for (String ele : clientIds) {
this.clientIds.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OpenIdConnectIdentityTokenConfiguration withClientIds(java.util.Collection clientIds) {
setClientIds(clientIds);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getPrincipalIdClaim() != null)
sb.append("PrincipalIdClaim: ").append("***Sensitive Data Redacted***").append(",");
if (getClientIds() != null)
sb.append("ClientIds: ").append("***Sensitive Data Redacted***");
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof OpenIdConnectIdentityTokenConfiguration == false)
return false;
OpenIdConnectIdentityTokenConfiguration other = (OpenIdConnectIdentityTokenConfiguration) obj;
if (other.getPrincipalIdClaim() == null ^ this.getPrincipalIdClaim() == null)
return false;
if (other.getPrincipalIdClaim() != null && other.getPrincipalIdClaim().equals(this.getPrincipalIdClaim()) == false)
return false;
if (other.getClientIds() == null ^ this.getClientIds() == null)
return false;
if (other.getClientIds() != null && other.getClientIds().equals(this.getClientIds()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getPrincipalIdClaim() == null) ? 0 : getPrincipalIdClaim().hashCode());
hashCode = prime * hashCode + ((getClientIds() == null) ? 0 : getClientIds().hashCode());
return hashCode;
}
@Override
public OpenIdConnectIdentityTokenConfiguration clone() {
try {
return (OpenIdConnectIdentityTokenConfiguration) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.verifiedpermissions.model.transform.OpenIdConnectIdentityTokenConfigurationMarshaller.getInstance().marshall(this,
protocolMarshaller);
}
}