Table of Contents

Class AssumeRoleWithSAMLResponse

Namespace
Amazon.SecurityToken.Model
Assembly
AWSSDK.SecurityToken.dll

Contains the response to a successful AssumeRoleWithSAML request, including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests.

public class AssumeRoleWithSAMLResponse : AmazonWebServiceResponse
Inheritance
AssumeRoleWithSAMLResponse

Constructors

AssumeRoleWithSAMLResponse() 

public AssumeRoleWithSAMLResponse()

Properties

AssumedRoleUser

Gets and sets the property AssumedRoleUser.

The identifiers for the temporary security credentials that the operation returns. 

public AssumedRoleUser AssumedRoleUser { get; set; }

Property Value

AssumedRoleUser

Audience

Gets and sets the property Audience.

The value of the 

Recipient
attribute of the 
SubjectConfirmationData
element of the SAML assertion. 
public string Audience { get; set; }

Property Value

string

Credentials

Gets and sets the property Credentials.

The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

note

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 Credentials Credentials { get; set; }

Property Value

Credentials

Issuer

Gets and sets the property Issuer.

The value of the 

Issuer
element of the SAML assertion. 
public string Issuer { get; set; }

Property Value

string

NameQualifier

Gets and sets the property 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"
                   ) )
public string NameQualifier { get; set; }

Property Value

string

PackedPolicySize

Gets and sets the property 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 int PackedPolicySize { get; set; }

Property Value

int

SourceIdentity

Gets and sets the property 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: =,.@- 

public string SourceIdentity { get; set; }

Property Value

string

Subject

Gets and sets the property Subject.

The value of the 

NameID
element in the 
Subject
element of the SAML assertion. 
public string Subject { get; set; }

Property Value

string

SubjectType

Gets and sets the property 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. 
public string SubjectType { get; set; }

Property Value

string