AssumeRoleWithSAMLResponse Class | AWS SDK for .NET V3

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

Inheritance Hierarchy

System.Object
Amazon.Runtime.AmazonWebServiceResponse
Amazon.SecurityToken.Model.AssumeRoleWithSAMLResponse

Namespace: Amazon.SecurityToken.Model
Assembly: AWSSDK.SecurityToken.dll
Version: 3.x.y.z

Syntax

public class AssumeRoleWithSAMLResponse : AmazonWebServiceResponse

The AssumeRoleWithSAMLResponse type exposes the following members

Constructors

	Name	Description
	AssumeRoleWithSAMLResponse()

Properties

Name	Type	Description
AssumedRoleUser	Amazon.SecurityToken.Model.AssumedRoleUser	Gets and sets the property AssumedRoleUser. The identifiers for the temporary security credentials that the operation returns.
Audience	System.String	Gets and sets the property Audience. The value of the `Recipient` attribute of the `SubjectConfirmationData` element of the SAML assertion.
ContentLength	System.Int64	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Credentials	Amazon.SecurityToken.Model.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. 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.
HttpStatusCode	System.Net.HttpStatusCode	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Issuer	System.String	Gets and sets the property Issuer. The value of the `Issuer` element of the SAML assertion.
NameQualifier	System.String	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 user. The following pseudocode shows how the hash value is calculated: `BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )`
PackedPolicySize	System.Int32	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.
ResponseMetadata	Amazon.Runtime.ResponseMetadata	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
SourceIdentity	System.String	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: =,.@-
Subject	System.String	Gets and sets the property Subject. The value of the `NameID` element in the `Subject` element of the SAML assertion.
SubjectType	System.String	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.

Examples

To assume a role using a SAML assertion


var client = new AmazonSecurityTokenServiceClient();
var response = client.AssumeRoleWithSAML(new AssumeRoleWithSAMLRequest 
{
    DurationSeconds = 3600,
    PrincipalArn = "arn:aws:iam::123456789012:saml-provider/SAML-test",
    RoleArn = "arn:aws:iam::123456789012:role/TestSaml",
    SAMLAssertion = "VERYLONGENCODEDASSERTIONEXAMPLExzYW1sOkF1ZGllbmNlPmJsYW5rPC9zYW1sOkF1ZGllbmNlPjwvc2FtbDpBdWRpZW5jZVJlc3RyaWN0aW9uPjwvc2FtbDpDb25kaXRpb25zPjxzYW1sOlN1YmplY3Q+PHNhbWw6TmFtZUlEIEZvcm1hdD0idXJuOm9hc2lzOm5hbWVzOnRjOlNBTUw6Mi4wOm5hbWVpZC1mb3JtYXQ6dHJhbnNpZW50Ij5TYW1sRXhhbXBsZTwvc2FtbDpOYW1lSUQ+PHNhbWw6U3ViamVjdENvbmZpcm1hdGlvbiBNZXRob2Q9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMDpjbTpiZWFyZXIiPjxzYW1sOlN1YmplY3RDb25maXJtYXRpb25EYXRhIE5vdE9uT3JBZnRlcj0iMjAxOS0xMS0wMVQyMDoyNTowNS4xNDVaIiBSZWNpcGllbnQ9Imh0dHBzOi8vc2lnbmluLmF3cy5hbWF6b24uY29tL3NhbWwiLz48L3NhbWw6U3ViamVjdENvbmZpcm1hdGlvbj48L3NhbWw6U3ViamVjdD48c2FtbDpBdXRoblN0YXRlbWVudCBBdXRoPD94bWwgdmpSZXNwb25zZT4="
});

AssumedRoleUser assumedRoleUser = response.AssumedRoleUser;
string audience = response.Audience;
Credentials credentials = response.Credentials;
string issuer = response.Issuer;
string nameQualifier = response.NameQualifier;
int packedPolicySize = response.PackedPolicySize;
string subject = response.Subject;
string subjectType = response.SubjectType;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5