com.amazonaws.services.ssooidc.model.CreateTokenWithIAMResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ssooidc 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.ssooidc.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateTokenWithIAMResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* A bearer token to access Amazon Web Services accounts and applications assigned to a user.
*
*/
private String accessToken;
/**
*
* Used to notify the requester that the returned token is an access token. The supported token type is
* Bearer.
*
*/
private String tokenType;
/**
*
* Indicates the time in seconds when an access token will expire.
*
*/
private Integer expiresIn;
/**
*
* A token that, if present, can be used to refresh a previously issued access token that might have expired.
*
*
* For more information about the features and limitations of the current IAM Identity Center OIDC implementation,
* see Considerations for Using this Guide in the IAM Identity Center OIDC API
* Reference.
*
*/
private String refreshToken;
/**
*
* A JSON Web Token (JWT) that identifies the user associated with the issued access token.
*
*/
private String idToken;
/**
*
* Indicates the type of tokens that are issued by IAM Identity Center. The following values are supported:
*
*
* * Access Token - urn:ietf:params:oauth:token-type:access_token
*
*
* * Refresh Token - urn:ietf:params:oauth:token-type:refresh_token
*
*/
private String issuedTokenType;
/**
*
* The list of scopes for which authorization is granted. The access token that is issued is limited to the scopes
* that are granted.
*
*/
private java.util.List scope;
/**
*
* A bearer token to access Amazon Web Services accounts and applications assigned to a user.
*
*
* @param accessToken
* A bearer token to access Amazon Web Services accounts and applications assigned to a user.
*/
public void setAccessToken(String accessToken) {
this.accessToken = accessToken;
}
/**
*
* A bearer token to access Amazon Web Services accounts and applications assigned to a user.
*
*
* @return A bearer token to access Amazon Web Services accounts and applications assigned to a user.
*/
public String getAccessToken() {
return this.accessToken;
}
/**
*
* A bearer token to access Amazon Web Services accounts and applications assigned to a user.
*
*
* @param accessToken
* A bearer token to access Amazon Web Services accounts and applications assigned to a user.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTokenWithIAMResult withAccessToken(String accessToken) {
setAccessToken(accessToken);
return this;
}
/**
*
* Used to notify the requester that the returned token is an access token. The supported token type is
* Bearer.
*
*
* @param tokenType
* Used to notify the requester that the returned token is an access token. The supported token type is
* Bearer.
*/
public void setTokenType(String tokenType) {
this.tokenType = tokenType;
}
/**
*
* Used to notify the requester that the returned token is an access token. The supported token type is
* Bearer.
*
*
* @return Used to notify the requester that the returned token is an access token. The supported token type is
* Bearer.
*/
public String getTokenType() {
return this.tokenType;
}
/**
*
* Used to notify the requester that the returned token is an access token. The supported token type is
* Bearer.
*
*
* @param tokenType
* Used to notify the requester that the returned token is an access token. The supported token type is
* Bearer.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTokenWithIAMResult withTokenType(String tokenType) {
setTokenType(tokenType);
return this;
}
/**
*
* Indicates the time in seconds when an access token will expire.
*
*
* @param expiresIn
* Indicates the time in seconds when an access token will expire.
*/
public void setExpiresIn(Integer expiresIn) {
this.expiresIn = expiresIn;
}
/**
*
* Indicates the time in seconds when an access token will expire.
*
*
* @return Indicates the time in seconds when an access token will expire.
*/
public Integer getExpiresIn() {
return this.expiresIn;
}
/**
*
* Indicates the time in seconds when an access token will expire.
*
*
* @param expiresIn
* Indicates the time in seconds when an access token will expire.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTokenWithIAMResult withExpiresIn(Integer expiresIn) {
setExpiresIn(expiresIn);
return this;
}
/**
*
* A token that, if present, can be used to refresh a previously issued access token that might have expired.
*
*
* For more information about the features and limitations of the current IAM Identity Center OIDC implementation,
* see Considerations for Using this Guide in the IAM Identity Center OIDC API
* Reference.
*
*
* @param refreshToken
* A token that, if present, can be used to refresh a previously issued access token that might have
* expired.
*
* For more information about the features and limitations of the current IAM Identity Center OIDC
* implementation, see Considerations for Using this Guide in the IAM Identity Center
* OIDC API Reference.
*/
public void setRefreshToken(String refreshToken) {
this.refreshToken = refreshToken;
}
/**
*
* A token that, if present, can be used to refresh a previously issued access token that might have expired.
*
*
* For more information about the features and limitations of the current IAM Identity Center OIDC implementation,
* see Considerations for Using this Guide in the IAM Identity Center OIDC API
* Reference.
*
*
* @return A token that, if present, can be used to refresh a previously issued access token that might have
* expired.
*
* For more information about the features and limitations of the current IAM Identity Center OIDC
* implementation, see Considerations for Using this Guide in the IAM Identity Center
* OIDC API Reference.
*/
public String getRefreshToken() {
return this.refreshToken;
}
/**
*
* A token that, if present, can be used to refresh a previously issued access token that might have expired.
*
*
* For more information about the features and limitations of the current IAM Identity Center OIDC implementation,
* see Considerations for Using this Guide in the IAM Identity Center OIDC API
* Reference.
*
*
* @param refreshToken
* A token that, if present, can be used to refresh a previously issued access token that might have
* expired.
*
* For more information about the features and limitations of the current IAM Identity Center OIDC
* implementation, see Considerations for Using this Guide in the IAM Identity Center
* OIDC API Reference.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTokenWithIAMResult withRefreshToken(String refreshToken) {
setRefreshToken(refreshToken);
return this;
}
/**
*
* A JSON Web Token (JWT) that identifies the user associated with the issued access token.
*
*
* @param idToken
* A JSON Web Token (JWT) that identifies the user associated with the issued access token.
*/
public void setIdToken(String idToken) {
this.idToken = idToken;
}
/**
*
* A JSON Web Token (JWT) that identifies the user associated with the issued access token.
*
*
* @return A JSON Web Token (JWT) that identifies the user associated with the issued access token.
*/
public String getIdToken() {
return this.idToken;
}
/**
*
* A JSON Web Token (JWT) that identifies the user associated with the issued access token.
*
*
* @param idToken
* A JSON Web Token (JWT) that identifies the user associated with the issued access token.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTokenWithIAMResult withIdToken(String idToken) {
setIdToken(idToken);
return this;
}
/**
*
* Indicates the type of tokens that are issued by IAM Identity Center. The following values are supported:
*
*
* * Access Token - urn:ietf:params:oauth:token-type:access_token
*
*
* * Refresh Token - urn:ietf:params:oauth:token-type:refresh_token
*
*
* @param issuedTokenType
* Indicates the type of tokens that are issued by IAM Identity Center. The following values are supported:
*
*
* Access Token - urn:ietf:params:oauth:token-type:access_token
*
*
* Refresh Token - urn:ietf:params:oauth:token-type:refresh_token
*/
public void setIssuedTokenType(String issuedTokenType) {
this.issuedTokenType = issuedTokenType;
}
/**
*
* Indicates the type of tokens that are issued by IAM Identity Center. The following values are supported:
*
*
* * Access Token - urn:ietf:params:oauth:token-type:access_token
*
*
* * Refresh Token - urn:ietf:params:oauth:token-type:refresh_token
*
*
* @return Indicates the type of tokens that are issued by IAM Identity Center. The following values are supported:
*
*
* Access Token - urn:ietf:params:oauth:token-type:access_token
*
*
* Refresh Token - urn:ietf:params:oauth:token-type:refresh_token
*/
public String getIssuedTokenType() {
return this.issuedTokenType;
}
/**
*
* Indicates the type of tokens that are issued by IAM Identity Center. The following values are supported:
*
*
* * Access Token - urn:ietf:params:oauth:token-type:access_token
*
*
* * Refresh Token - urn:ietf:params:oauth:token-type:refresh_token
*
*
* @param issuedTokenType
* Indicates the type of tokens that are issued by IAM Identity Center. The following values are supported:
*
*
* Access Token - urn:ietf:params:oauth:token-type:access_token
*
*
* Refresh Token - urn:ietf:params:oauth:token-type:refresh_token
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTokenWithIAMResult withIssuedTokenType(String issuedTokenType) {
setIssuedTokenType(issuedTokenType);
return this;
}
/**
*
* The list of scopes for which authorization is granted. The access token that is issued is limited to the scopes
* that are granted.
*
*
* @return The list of scopes for which authorization is granted. The access token that is issued is limited to the
* scopes that are granted.
*/
public java.util.List getScope() {
return scope;
}
/**
*
* The list of scopes for which authorization is granted. The access token that is issued is limited to the scopes
* that are granted.
*
*
* @param scope
* The list of scopes for which authorization is granted. The access token that is issued is limited to the
* scopes that are granted.
*/
public void setScope(java.util.Collection scope) {
if (scope == null) {
this.scope = null;
return;
}
this.scope = new java.util.ArrayList(scope);
}
/**
*
* The list of scopes for which authorization is granted. The access token that is issued is limited to the scopes
* that are granted.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setScope(java.util.Collection)} or {@link #withScope(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param scope
* The list of scopes for which authorization is granted. The access token that is issued is limited to the
* scopes that are granted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTokenWithIAMResult withScope(String... scope) {
if (this.scope == null) {
setScope(new java.util.ArrayList(scope.length));
}
for (String ele : scope) {
this.scope.add(ele);
}
return this;
}
/**
*
* The list of scopes for which authorization is granted. The access token that is issued is limited to the scopes
* that are granted.
*
*
* @param scope
* The list of scopes for which authorization is granted. The access token that is issued is limited to the
* scopes that are granted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateTokenWithIAMResult withScope(java.util.Collection scope) {
setScope(scope);
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 (getAccessToken() != null)
sb.append("AccessToken: ").append("***Sensitive Data Redacted***").append(",");
if (getTokenType() != null)
sb.append("TokenType: ").append(getTokenType()).append(",");
if (getExpiresIn() != null)
sb.append("ExpiresIn: ").append(getExpiresIn()).append(",");
if (getRefreshToken() != null)
sb.append("RefreshToken: ").append("***Sensitive Data Redacted***").append(",");
if (getIdToken() != null)
sb.append("IdToken: ").append("***Sensitive Data Redacted***").append(",");
if (getIssuedTokenType() != null)
sb.append("IssuedTokenType: ").append(getIssuedTokenType()).append(",");
if (getScope() != null)
sb.append("Scope: ").append(getScope());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateTokenWithIAMResult == false)
return false;
CreateTokenWithIAMResult other = (CreateTokenWithIAMResult) obj;
if (other.getAccessToken() == null ^ this.getAccessToken() == null)
return false;
if (other.getAccessToken() != null && other.getAccessToken().equals(this.getAccessToken()) == false)
return false;
if (other.getTokenType() == null ^ this.getTokenType() == null)
return false;
if (other.getTokenType() != null && other.getTokenType().equals(this.getTokenType()) == false)
return false;
if (other.getExpiresIn() == null ^ this.getExpiresIn() == null)
return false;
if (other.getExpiresIn() != null && other.getExpiresIn().equals(this.getExpiresIn()) == false)
return false;
if (other.getRefreshToken() == null ^ this.getRefreshToken() == null)
return false;
if (other.getRefreshToken() != null && other.getRefreshToken().equals(this.getRefreshToken()) == false)
return false;
if (other.getIdToken() == null ^ this.getIdToken() == null)
return false;
if (other.getIdToken() != null && other.getIdToken().equals(this.getIdToken()) == false)
return false;
if (other.getIssuedTokenType() == null ^ this.getIssuedTokenType() == null)
return false;
if (other.getIssuedTokenType() != null && other.getIssuedTokenType().equals(this.getIssuedTokenType()) == false)
return false;
if (other.getScope() == null ^ this.getScope() == null)
return false;
if (other.getScope() != null && other.getScope().equals(this.getScope()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAccessToken() == null) ? 0 : getAccessToken().hashCode());
hashCode = prime * hashCode + ((getTokenType() == null) ? 0 : getTokenType().hashCode());
hashCode = prime * hashCode + ((getExpiresIn() == null) ? 0 : getExpiresIn().hashCode());
hashCode = prime * hashCode + ((getRefreshToken() == null) ? 0 : getRefreshToken().hashCode());
hashCode = prime * hashCode + ((getIdToken() == null) ? 0 : getIdToken().hashCode());
hashCode = prime * hashCode + ((getIssuedTokenType() == null) ? 0 : getIssuedTokenType().hashCode());
hashCode = prime * hashCode + ((getScope() == null) ? 0 : getScope().hashCode());
return hashCode;
}
@Override
public CreateTokenWithIAMResult clone() {
try {
return (CreateTokenWithIAMResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}