Copyright | (c) 2013-2017 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.
The SAML provider resource that you create with this operation can be used as a principal in an IAM role's trust policy to enable federated users who sign-in using the SAML IdP to assume the role. 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 resource, 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 the IdP sends. You must generate the metadata document using the identity management software that is used as your organization's IdP.
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 .
- 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
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:
csamlpSAMLMetadataDocument
- 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 GuidecsamlpName
- The name of the provider to create. This parameter allows (per its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
data CreateSAMLProvider Source #
See: createSAMLProvider
smart constructor.
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. This parameter allows (per its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-
Destructuring the Response
createSAMLProviderResponse Source #
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:
csamlprsSAMLProviderARN
- The Amazon Resource Name (ARN) of the new SAML provider resource in IAM.csamlprsResponseStatus
- -- | The response status code.
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 new SAML provider resource in IAM.
csamlprsResponseStatus :: Lens' CreateSAMLProviderResponse Int Source #
- - | The response status code.