@Generated(value="software.amazon.awssdk:codegen") public final class AssumeRoleWithSamlResponse extends StsResponse implements ToCopyableBuilder<AssumeRoleWithSamlResponse.Builder,AssumeRoleWithSamlResponse>
Contains the response to a successful AssumeRoleWithSAML request, including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests.
Modifier and Type | Class and Description |
---|---|
static interface |
AssumeRoleWithSamlResponse.Builder |
Modifier and Type | Method and Description |
---|---|
AssumedRoleUser |
assumedRoleUser()
The identifiers for the temporary security credentials that the operation returns.
|
String |
audience()
The value of the
Recipient attribute of the SubjectConfirmationData element of the SAML
assertion. |
static AssumeRoleWithSamlResponse.Builder |
builder() |
Credentials |
credentials()
The temporary security credentials, which include an access key ID, a secret access key, and a security (or
session) token.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
issuer()
The value of the
Issuer element of the SAML assertion. |
String |
nameQualifier()
A hash value based on the concatenation of the following:
|
Integer |
packedPolicySize()
A percentage value that indicates the packed size of the session policies and session tags combined passed in the
request.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends AssumeRoleWithSamlResponse.Builder> |
serializableBuilderClass() |
String |
sourceIdentity()
The value in the
SourceIdentity attribute in the SAML assertion. |
String |
subject()
The value of the
NameID element in the Subject element of the SAML assertion. |
String |
subjectType()
The format of the name ID, as defined by the
Format attribute in the NameID element of
the SAML assertion. |
AssumeRoleWithSamlResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
responseMetadata
sdkHttpResponse
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final Credentials credentials()
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.
The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.
public final AssumedRoleUser assumedRoleUser()
The identifiers for the temporary security credentials that the operation returns.
public final Integer packedPolicySize()
A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space.
public final String subject()
The value of the NameID
element in the Subject
element of the SAML assertion.
NameID
element in the Subject
element of the SAML assertion.public final String subjectType()
The format of the name ID, as defined by the Format
attribute in the NameID
element of
the SAML assertion. Typical examples of the format are transient
or persistent
.
If the format includes the prefix urn:oasis:names:tc:SAML:2.0:nameid-format
, that prefix is removed.
For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient
is returned as
transient
. If the format includes any other prefix, the format is returned with no modifications.
Format
attribute in the NameID
element of the SAML assertion. Typical examples of the format are transient
or
persistent
.
If the format includes the prefix urn:oasis:names:tc:SAML:2.0:nameid-format
, that prefix is
removed. For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient
is returned as
transient
. If the format includes any other prefix, the format is returned with no
modifications.
public final String issuer()
The value of the Issuer
element of the SAML assertion.
Issuer
element of the SAML assertion.public final String audience()
The value of the Recipient
attribute of the SubjectConfirmationData
element of the SAML
assertion.
Recipient
attribute of the SubjectConfirmationData
element of
the SAML assertion.public final String nameQualifier()
A hash value based on the concatenation of the following:
The Issuer
response value.
The Amazon Web Services account ID.
The friendly name (the last part of the ARN) of the SAML provider in IAM.
The combination of NameQualifier
and Subject
can be used to uniquely identify a
federated user.
The following pseudocode shows how the hash value is calculated:
BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )
The Issuer
response value.
The Amazon Web Services account ID.
The friendly name (the last part of the ARN) of the SAML provider in IAM.
The combination of NameQualifier
and Subject
can be used to uniquely identify a
federated user.
The following pseudocode shows how the hash value is calculated:
BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )
public final String sourceIdentity()
The value in the SourceIdentity
attribute in the SAML assertion.
You can require users to set a source identity value when they assume a role. You do this by using the
sts:SourceIdentity
condition key in a role trust policy. That way, actions that are taken with the
role are associated with that user. After the source identity is set, the value cannot be changed. It is present
in the request for all actions that are taken by the role and persists across chained role sessions. You can configure your SAML identity provider to use an attribute associated with
your users, like user name or email, as the source identity when calling AssumeRoleWithSAML
. You do
this by adding an attribute to the SAML assertion. For more information about using source identity, see Monitor
and control actions taken with assumed roles in the IAM User Guide.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-
SourceIdentity
attribute in the SAML assertion.
You can require users to set a source identity value when they assume a role. You do this by using the
sts:SourceIdentity
condition key in a role trust policy. That way, actions that are taken
with the role are associated with that user. After the source identity is set, the value cannot be
changed. It is present in the request for all actions that are taken by the role and persists across chained role sessions. You can configure your SAML identity provider to use an attribute associated
with your users, like user name or email, as the source identity when calling
AssumeRoleWithSAML
. You do this by adding an attribute to the SAML assertion. For more
information about using source identity, see Monitor and control actions taken with assumed roles in the IAM User Guide.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-
public AssumeRoleWithSamlResponse.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<AssumeRoleWithSamlResponse.Builder,AssumeRoleWithSamlResponse>
toBuilder
in class AwsResponse
public static AssumeRoleWithSamlResponse.Builder builder()
public static Class<? extends AssumeRoleWithSamlResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsResponse
public final boolean equals(Object obj)
equals
in class AwsResponse
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkResponse
Copyright © 2022. All rights reserved.