GetSAMLProvider
Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.
Note
This operation requires Signature Version 4.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- SAMLProviderArn
-
The Amazon Resource Name (ARN) of the SAML provider resource object in IAM to get information about.
For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Required: Yes
Response Elements
The following elements are returned by the service.
- AssertionEncryptionMode
-
Specifies the encryption setting for the SAML provider.
Type: String
Valid Values:
Required | Allowed - CreateDate
-
The date and time when the SAML provider was created.
Type: Timestamp
- PrivateKeyList.member.N
-
The private key metadata for the SAML provider.
Type: Array of SAMLPrivateKey objects
Array Members: Maximum number of 2 items.
- SAMLMetadataDocument
-
The XML metadata document that includes information about an identity provider.
Type: String
Length Constraints: Minimum length of 1000. Maximum length of 10000000.
- SAMLProviderUUID
-
The unique identifier assigned to the SAML provider.
Type: String
Length Constraints: Minimum length of 22. Maximum length of 64.
Pattern:
[A-Z0-9]+ - Tags.member.N
-
A list of tags that are attached to the specified IAM SAML provider. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Type: Array of Tag objects
Array Members: Maximum number of 50 items.
- ValidUntil
-
The expiration date and time for the SAML provider.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidInput
-
The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
HTTP Status Code: 400
- NoSuchEntity
-
The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
HTTP Status Code: 404
- ServiceFailure
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
Examples
Example
This example illustrates one usage of GetSAMLProvider.
Sample Request
https://iam.amazonaws.com/?Action=GetSAMLProvider
&Name=arn:aws:iam::123456789012:saml-provider/MyUniversity
&Version=2010-05-08
&AUTHPARAMSSample Response
<GetSAMLProviderResponse xmlns="https://iam.amazonaws.com/doc/2010-05-08/">
<GetSAMLProviderResult>
<AssertionEncryptionMode>Allowed</AssertionEncryptionMode>
<CreateDate>2012-05-09T16:27:11Z</CreateDate>
<ValidUntil>2015-12-31T211:59:59Z</ValidUntil>
<SAMLMetadataDocument>Pd9fexDssTkRgGNqs...DxptfEs==</SAMLMetadataDocument>
<PrivateKeyList>
<member>
<KeyId>SAMLPKOQIX75IETFBAK8F6</KeyId>
<Timestamp>2024-06-02T17:01:44Z</Timestamp>
</member>
<member>
<KeyId>SAMLNLPRIX13IASBCAW4F3</KeyId>
<Timestamp>2024-07-03T18:03:44Z</Timestamp>
</member>
</PrivateKeyList>
</GetSAMLProviderResult>
<ResponseMetadata>
<RequestId>29f47818-99f5-11e1-a4c3-27EXAMPLE804</RequestId>
</ResponseMetadata>
</GetSAMLProviderResponse>See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
