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 |
Updates the identity provider.
Synopsis
- data UpdateIdentityProvider = UpdateIdentityProvider' {}
- newUpdateIdentityProvider :: Text -> UpdateIdentityProvider
- updateIdentityProvider_clientToken :: Lens' UpdateIdentityProvider (Maybe Text)
- updateIdentityProvider_identityProviderDetails :: Lens' UpdateIdentityProvider (Maybe (HashMap Text Text))
- updateIdentityProvider_identityProviderName :: Lens' UpdateIdentityProvider (Maybe Text)
- updateIdentityProvider_identityProviderType :: Lens' UpdateIdentityProvider (Maybe IdentityProviderType)
- updateIdentityProvider_identityProviderArn :: Lens' UpdateIdentityProvider Text
- data UpdateIdentityProviderResponse = UpdateIdentityProviderResponse' {}
- newUpdateIdentityProviderResponse :: Int -> IdentityProvider -> UpdateIdentityProviderResponse
- updateIdentityProviderResponse_httpStatus :: Lens' UpdateIdentityProviderResponse Int
- updateIdentityProviderResponse_identityProvider :: Lens' UpdateIdentityProviderResponse IdentityProvider
Creating a Request
data UpdateIdentityProvider Source #
See: newUpdateIdentityProvider
smart constructor.
UpdateIdentityProvider' | |
|
Instances
newUpdateIdentityProvider Source #
Create a value of UpdateIdentityProvider
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:UpdateIdentityProvider'
, updateIdentityProvider_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
return the result from the original successful request.
If you do not specify a client token, one is automatically generated by the AWS SDK.
UpdateIdentityProvider
, updateIdentityProvider_identityProviderDetails
- The details of the identity provider. 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
UpdateIdentityProvider
, updateIdentityProvider_identityProviderName
- The name of the identity provider.
UpdateIdentityProvider
, updateIdentityProvider_identityProviderType
- The type of the identity provider.
UpdateIdentityProvider
, updateIdentityProvider_identityProviderArn
- The ARN of the identity provider.
Request Lenses
updateIdentityProvider_clientToken :: Lens' UpdateIdentityProvider (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 return the result from the original successful request.
If you do not specify a client token, one is automatically generated by the AWS SDK.
updateIdentityProvider_identityProviderDetails :: Lens' UpdateIdentityProvider (Maybe (HashMap Text Text)) Source #
The details of the identity provider. 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
updateIdentityProvider_identityProviderName :: Lens' UpdateIdentityProvider (Maybe Text) Source #
The name of the identity provider.
updateIdentityProvider_identityProviderType :: Lens' UpdateIdentityProvider (Maybe IdentityProviderType) Source #
The type of the identity provider.
updateIdentityProvider_identityProviderArn :: Lens' UpdateIdentityProvider Text Source #
The ARN of the identity provider.
Destructuring the Response
data UpdateIdentityProviderResponse Source #
See: newUpdateIdentityProviderResponse
smart constructor.
UpdateIdentityProviderResponse' | |
|
Instances
Generic UpdateIdentityProviderResponse Source # | |
Show UpdateIdentityProviderResponse Source # | |
NFData UpdateIdentityProviderResponse Source # | |
Defined in Amazonka.WorkSpacesWeb.UpdateIdentityProvider rnf :: UpdateIdentityProviderResponse -> () # | |
Eq UpdateIdentityProviderResponse Source # | |
type Rep UpdateIdentityProviderResponse Source # | |
Defined in Amazonka.WorkSpacesWeb.UpdateIdentityProvider type Rep UpdateIdentityProviderResponse = D1 ('MetaData "UpdateIdentityProviderResponse" "Amazonka.WorkSpacesWeb.UpdateIdentityProvider" "amazonka-workspaces-web-2.0-7elUOg7oNE07CClY3TuUcU" 'False) (C1 ('MetaCons "UpdateIdentityProviderResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "identityProvider") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IdentityProvider))) |
newUpdateIdentityProviderResponse Source #
Create a value of UpdateIdentityProviderResponse
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:UpdateIdentityProviderResponse'
, updateIdentityProviderResponse_httpStatus
- The response's http status code.
$sel:identityProvider:UpdateIdentityProviderResponse'
, updateIdentityProviderResponse_identityProvider
- The identity provider.
Response Lenses
updateIdentityProviderResponse_httpStatus :: Lens' UpdateIdentityProviderResponse Int Source #
The response's http status code.
updateIdentityProviderResponse_identityProvider :: Lens' UpdateIdentityProviderResponse IdentityProvider Source #
The identity provider.