Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Creates an identity provider resource that is then associated with a web portal.
Synopsis
- data CreateIdentityProvider = CreateIdentityProvider' {}
- newCreateIdentityProvider :: Text -> IdentityProviderType -> Text -> CreateIdentityProvider
- createIdentityProvider_clientToken :: Lens' CreateIdentityProvider (Maybe Text)
- createIdentityProvider_identityProviderDetails :: Lens' CreateIdentityProvider (HashMap Text Text)
- createIdentityProvider_identityProviderName :: Lens' CreateIdentityProvider Text
- createIdentityProvider_identityProviderType :: Lens' CreateIdentityProvider IdentityProviderType
- createIdentityProvider_portalArn :: Lens' CreateIdentityProvider Text
- data CreateIdentityProviderResponse = CreateIdentityProviderResponse' {}
- newCreateIdentityProviderResponse :: Int -> Text -> CreateIdentityProviderResponse
- createIdentityProviderResponse_httpStatus :: Lens' CreateIdentityProviderResponse Int
- createIdentityProviderResponse_identityProviderArn :: Lens' CreateIdentityProviderResponse Text
Creating a Request
data CreateIdentityProvider Source #
See: newCreateIdentityProvider
smart constructor.
CreateIdentityProvider' | |
|
Instances
newCreateIdentityProvider Source #
Create a value of CreateIdentityProvider
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateIdentityProvider'
, createIdentityProvider_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. Idempotency ensures that an API request
completes only once. With an idempotent request, if the original request
completes successfully, subsequent retries with the same client token
returns the result from the original successful request.
If you do not specify a client token, one is automatically generated by the AWS SDK.
CreateIdentityProvider
, createIdentityProvider_identityProviderDetails
- The identity provider details. The following list describes the provider
detail keys for each identity provider type.
For Google and Login with Amazon:
client_id
client_secret
authorize_scopes
For Facebook:
client_id
client_secret
authorize_scopes
api_version
For Sign in with Apple:
client_id
team_id
key_id
private_key
authorize_scopes
For OIDC providers:
client_id
client_secret
attributes_request_method
oidc_issuer
authorize_scopes
authorize_url
/if not available from discovery URL specified byoidc_issuer
key/token_url
/if not available from discovery URL specified byoidc_issuer
key/attributes_url
/if not available from discovery URL specified byoidc_issuer
key/jwks_uri
/if not available from discovery URL specified byoidc_issuer
key/
For SAML providers:
MetadataFile
ORMetadataURL
IDPSignout
(boolean) optional
CreateIdentityProvider
, createIdentityProvider_identityProviderName
- The identity provider name.
CreateIdentityProvider
, createIdentityProvider_identityProviderType
- The identity provider type.
CreateIdentityProvider
, createIdentityProvider_portalArn
- The ARN of the web portal.
Request Lenses
createIdentityProvider_clientToken :: Lens' CreateIdentityProvider (Maybe Text) Source #
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.
If you do not specify a client token, one is automatically generated by the AWS SDK.
createIdentityProvider_identityProviderDetails :: Lens' CreateIdentityProvider (HashMap Text Text) Source #
The identity provider details. The following list describes the provider detail keys for each identity provider type.
For Google and Login with Amazon:
client_id
client_secret
authorize_scopes
For Facebook:
client_id
client_secret
authorize_scopes
api_version
For Sign in with Apple:
client_id
team_id
key_id
private_key
authorize_scopes
For OIDC providers:
client_id
client_secret
attributes_request_method
oidc_issuer
authorize_scopes
authorize_url
/if not available from discovery URL specified byoidc_issuer
key/token_url
/if not available from discovery URL specified byoidc_issuer
key/attributes_url
/if not available from discovery URL specified byoidc_issuer
key/jwks_uri
/if not available from discovery URL specified byoidc_issuer
key/
For SAML providers:
MetadataFile
ORMetadataURL
IDPSignout
(boolean) optional
createIdentityProvider_identityProviderName :: Lens' CreateIdentityProvider Text Source #
The identity provider name.
createIdentityProvider_identityProviderType :: Lens' CreateIdentityProvider IdentityProviderType Source #
The identity provider type.
createIdentityProvider_portalArn :: Lens' CreateIdentityProvider Text Source #
The ARN of the web portal.
Destructuring the Response
data CreateIdentityProviderResponse Source #
See: newCreateIdentityProviderResponse
smart constructor.
CreateIdentityProviderResponse' | |
|
Instances
Generic CreateIdentityProviderResponse Source # | |
Read CreateIdentityProviderResponse Source # | |
Show CreateIdentityProviderResponse Source # | |
NFData CreateIdentityProviderResponse Source # | |
Defined in Amazonka.WorkSpacesWeb.CreateIdentityProvider rnf :: CreateIdentityProviderResponse -> () # | |
Eq CreateIdentityProviderResponse Source # | |
type Rep CreateIdentityProviderResponse Source # | |
Defined in Amazonka.WorkSpacesWeb.CreateIdentityProvider type Rep CreateIdentityProviderResponse = D1 ('MetaData "CreateIdentityProviderResponse" "Amazonka.WorkSpacesWeb.CreateIdentityProvider" "amazonka-workspaces-web-2.0-7elUOg7oNE07CClY3TuUcU" 'False) (C1 ('MetaCons "CreateIdentityProviderResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "identityProviderArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
newCreateIdentityProviderResponse Source #
Create a value of CreateIdentityProviderResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateIdentityProviderResponse'
, createIdentityProviderResponse_httpStatus
- The response's http status code.
CreateIdentityProviderResponse
, createIdentityProviderResponse_identityProviderArn
- The ARN of the identity provider.
Response Lenses
createIdentityProviderResponse_httpStatus :: Lens' CreateIdentityProviderResponse Int Source #
The response's http status code.
createIdentityProviderResponse_identityProviderArn :: Lens' CreateIdentityProviderResponse Text Source #
The ARN of the identity provider.