| Copyright | (c) 2013-2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.IAM.CreateSAMLProvider
Description
Creates an IAM entity to describe an identity provider (IdP) that supports SAML 2.0.
The SAML provider that you create with this operation can be used as a principal in a role's trust policy to establish a trust relationship between AWS and a SAML identity provider. You can create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one that supports API access to AWS.
When you create the SAML provider, you upload an a SAML metadata document that you get from your IdP and that includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.
This operation requires Signature Version 4.
For more information, see Enabling SAML 2.0 Federated Users to Access the AWS Management Console and About SAML 2.0-based Federation in the IAM User Guide.
See: AWS API Reference for CreateSAMLProvider.
- createSAMLProvider :: Text -> Text -> CreateSAMLProvider
- data CreateSAMLProvider
- csamlpSAMLMetadataDocument :: Lens' CreateSAMLProvider Text
- csamlpName :: Lens' CreateSAMLProvider Text
- createSAMLProviderResponse :: Int -> CreateSAMLProviderResponse
- data CreateSAMLProviderResponse
- csamlprsSAMLProviderARN :: Lens' CreateSAMLProviderResponse (Maybe Text)
- csamlprsResponseStatus :: Lens' CreateSAMLProviderResponse Int
Creating a Request
Arguments
| :: Text | |
| -> Text | |
| -> CreateSAMLProvider |
Creates a value of CreateSAMLProvider with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CreateSAMLProvider Source
See: createSAMLProvider smart constructor.
Instances
Request Lenses
csamlpSAMLMetadataDocument :: Lens' CreateSAMLProvider Text Source
An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.
For more information, see About SAML 2.0-based Federation in the IAM User Guide
csamlpName :: Lens' CreateSAMLProvider Text Source
The name of the provider to create.
Destructuring the Response
createSAMLProviderResponse Source
Arguments
| :: Int | |
| -> CreateSAMLProviderResponse |
Creates a value of CreateSAMLProviderResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CreateSAMLProviderResponse Source
Contains the response to a successful CreateSAMLProvider request.
See: createSAMLProviderResponse smart constructor.
Response Lenses
csamlprsSAMLProviderARN :: Lens' CreateSAMLProviderResponse (Maybe Text) Source
The Amazon Resource Name (ARN) of the SAML provider.
csamlprsResponseStatus :: Lens' CreateSAMLProviderResponse Int Source
The response status code.