« blib/lib/Paws/STS/AssumeRoleWithSAML.pm
↑ Summary
blib/lib/Paws/STS/AssumeRoleWithWebIdentity.pm »
| 1 | |||
| 2 | package Paws::STS::AssumeRoleWithSAMLResponse; | ||
| 3 | use Moose; | ||
| 4 | has AssumedRoleUser => (is => 'ro', isa => 'Paws::STS::AssumedRoleUser'); | ||
| 5 | has Audience => (is => 'ro', isa => 'Str'); | ||
| 6 | has Credentials => (is => 'ro', isa => 'Paws::STS::Credentials'); | ||
| 7 | has Issuer => (is => 'ro', isa => 'Str'); | ||
| 8 | has NameQualifier => (is => 'ro', isa => 'Str'); | ||
| 9 | has PackedPolicySize => (is => 'ro', isa => 'Int'); | ||
| 10 | has SourceIdentity => (is => 'ro', isa => 'Str'); | ||
| 11 | has Subject => (is => 'ro', isa => 'Str'); | ||
| 12 | has SubjectType => (is => 'ro', isa => 'Str'); | ||
| 13 | |||
| 14 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::STS::AssumeRoleWithSAMLResponse | ||
| 22 | |||
| 23 | =head1 ATTRIBUTES | ||
| 24 | |||
| 25 | |||
| 26 | =head2 AssumedRoleUser => L<Paws::STS::AssumedRoleUser> | ||
| 27 | |||
| 28 | The identifiers for the temporary security credentials that the | ||
| 29 | operation returns. | ||
| 30 | |||
| 31 | |||
| 32 | =head2 Audience => Str | ||
| 33 | |||
| 34 | The value of the C<Recipient> attribute of the | ||
| 35 | C<SubjectConfirmationData> element of the SAML assertion. | ||
| 36 | |||
| 37 | |||
| 38 | =head2 Credentials => L<Paws::STS::Credentials> | ||
| 39 | |||
| 40 | The temporary security credentials, which include an access key ID, a | ||
| 41 | secret access key, and a security (or session) token. | ||
| 42 | |||
| 43 | The size of the security token that STS API operations return is not | ||
| 44 | fixed. We strongly recommend that you make no assumptions about the | ||
| 45 | maximum size. | ||
| 46 | |||
| 47 | |||
| 48 | =head2 Issuer => Str | ||
| 49 | |||
| 50 | The value of the C<Issuer> element of the SAML assertion. | ||
| 51 | |||
| 52 | |||
| 53 | =head2 NameQualifier => Str | ||
| 54 | |||
| 55 | A hash value based on the concatenation of the following: | ||
| 56 | |||
| 57 | =over | ||
| 58 | |||
| 59 | =item * | ||
| 60 | |||
| 61 | The C<Issuer> response value. | ||
| 62 | |||
| 63 | =item * | ||
| 64 | |||
| 65 | The AWS account ID. | ||
| 66 | |||
| 67 | =item * | ||
| 68 | |||
| 69 | The friendly name (the last part of the ARN) of the SAML provider in | ||
| 70 | IAM. | ||
| 71 | |||
| 72 | =back | ||
| 73 | |||
| 74 | The combination of C<NameQualifier> and C<Subject> can be used to | ||
| 75 | uniquely identify a federated user. | ||
| 76 | |||
| 77 | The following pseudocode shows how the hash value is calculated: | ||
| 78 | |||
| 79 | C<BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + | ||
| 80 | "/MySAMLIdP" ) )> | ||
| 81 | |||
| 82 | |||
| 83 | =head2 PackedPolicySize => Int | ||
| 84 | |||
| 85 | A percentage value that indicates the packed size of the session | ||
| 86 | policies and session tags combined passed in the request. The request | ||
| 87 | fails if the packed size is greater than 100 percent, which means the | ||
| 88 | policies and tags exceeded the allowed space. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 SourceIdentity => Str | ||
| 92 | |||
| 93 | The value in the C<SourceIdentity> attribute in the SAML assertion. | ||
| 94 | |||
| 95 | You can require users to set a source identity value when they assume a | ||
| 96 | role. You do this by using the C<sts:SourceIdentity> condition key in a | ||
| 97 | role trust policy. That way, actions that are taken with the role are | ||
| 98 | associated with that user. After the source identity is set, the value | ||
| 99 | cannot be changed. It is present in the request for all actions that | ||
| 100 | are taken by the role and persists across chained role | ||
| 101 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts#iam-term-role-chaining) | ||
| 102 | sessions. You can configure your SAML identity provider to use an | ||
| 103 | attribute associated with your users, like user name or email, as the | ||
| 104 | source identity when calling C<AssumeRoleWithSAML>. You do this by | ||
| 105 | adding an attribute to the SAML assertion. For more information about | ||
| 106 | using source identity, see Monitor and control actions taken with | ||
| 107 | assumed roles | ||
| 108 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html) | ||
| 109 | in the I<IAM User Guide>. | ||
| 110 | |||
| 111 | The regex used to validate this parameter is a string of characters | ||
| 112 | consisting of upper- and lower-case alphanumeric characters with no | ||
| 113 | spaces. You can also include underscores or any of the following | ||
| 114 | characters: =,.@- | ||
| 115 | |||
| 116 | |||
| 117 | =head2 Subject => Str | ||
| 118 | |||
| 119 | The value of the C<NameID> element in the C<Subject> element of the | ||
| 120 | SAML assertion. | ||
| 121 | |||
| 122 | |||
| 123 | =head2 SubjectType => Str | ||
| 124 | |||
| 125 | The format of the name ID, as defined by the C<Format> attribute in the | ||
| 126 | C<NameID> element of the SAML assertion. Typical examples of the format | ||
| 127 | are C<transient> or C<persistent>. | ||
| 128 | |||
| 129 | If the format includes the prefix | ||
| 130 | C<urn:oasis:names:tc:SAML:2.0:nameid-format>, that prefix is removed. | ||
| 131 | For example, C<urn:oasis:names:tc:SAML:2.0:nameid-format:transient> is | ||
| 132 | returned as C<transient>. If the format includes any other prefix, the | ||
| 133 | format is returned with no modifications. | ||
| 134 | |||
| 135 | |||
| 136 | =head2 _request_id => Str | ||
| 137 | |||
| 138 | |||
| 139 | =cut | ||
| 140 |