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

Amazonka.WorkSpacesWeb.Types.IdentityProvider

Description

Documentation

data IdentityProvider Source #

The identity provider.

See: newIdentityProvider smart constructor.

Constructors

IdentityProvider'

Fields

identityProviderDetails :: Maybe (Sensitive (HashMap Text Text))
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 by oidc_issuer key/
- token_url /if not available from discovery URL specified by oidc_issuer key/
- attributes_url /if not available from discovery URL specified by oidc_issuer key/
- jwks_uri /if not available from discovery URL specified by oidc_issuer key/
- For SAML providers:
  - MetadataFile OR MetadataURL
  - IDPSignout optional
identityProviderName :: Maybe (Sensitive Text)
The identity provider name.
identityProviderType :: Maybe IdentityProviderType
The identity provider type.
identityProviderArn :: Text
The ARN of the identity provider.

Instances

Instances details

FromJSON IdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.Types.IdentityProvider Methods parseJSON :: Value -> Parser IdentityProvider # parseJSONList :: Value -> Parser [IdentityProvider] #
Generic IdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.Types.IdentityProvider Associated Types type Rep IdentityProvider :: Type -> Type # Methods from :: IdentityProvider -> Rep IdentityProvider x # to :: Rep IdentityProvider x -> IdentityProvider #
Show IdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.Types.IdentityProvider Methods showsPrec :: Int -> IdentityProvider -> ShowS # show :: IdentityProvider -> String # showList :: [IdentityProvider] -> ShowS #
NFData IdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.Types.IdentityProvider Methods rnf :: IdentityProvider -> () #
Eq IdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.Types.IdentityProvider Methods (==) :: IdentityProvider -> IdentityProvider -> Bool # (/=) :: IdentityProvider -> IdentityProvider -> Bool #
Hashable IdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.Types.IdentityProvider Methods hashWithSalt :: Int -> IdentityProvider -> Int # hash :: IdentityProvider -> Int #
type Rep IdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.Types.IdentityProvider type Rep IdentityProvider = D1 ('MetaData "IdentityProvider" "Amazonka.WorkSpacesWeb.Types.IdentityProvider" "amazonka-workspaces-web-2.0-7elUOg7oNE07CClY3TuUcU" 'False) (C1 ('MetaCons "IdentityProvider'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "identityProviderDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (HashMap Text Text)))) :: S1 ('MetaSel ('Just "identityProviderName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "identityProviderType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IdentityProviderType)) :*: S1 ('MetaSel ('Just "identityProviderArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newIdentityProvider Source #

Arguments

:: Text	`$sel:identityProviderArn:IdentityProvider'`
-> IdentityProvider

Create a value of IdentityProvider 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:identityProviderDetails:IdentityProvider', identityProvider_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 by oidc_issuer key/
- token_url /if not available from discovery URL specified by oidc_issuer key/
- attributes_url /if not available from discovery URL specified by oidc_issuer key/
- jwks_uri /if not available from discovery URL specified by oidc_issuer key/
For SAML providers:
- MetadataFile OR MetadataURL
- IDPSignout optional

$sel:identityProviderName:IdentityProvider', identityProvider_identityProviderName - The identity provider name.

$sel:identityProviderType:IdentityProvider', identityProvider_identityProviderType - The identity provider type.

$sel:identityProviderArn:IdentityProvider', identityProvider_identityProviderArn - The ARN of the identity provider.

identityProvider_identityProviderDetails :: Lens' IdentityProvider (Maybe (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 by oidc_issuer key/
- token_url /if not available from discovery URL specified by oidc_issuer key/
- attributes_url /if not available from discovery URL specified by oidc_issuer key/
- jwks_uri /if not available from discovery URL specified by oidc_issuer key/
For SAML providers:
- MetadataFile OR MetadataURL
- IDPSignout optional

identityProvider_identityProviderName :: Lens' IdentityProvider (Maybe Text) Source #

The identity provider name.

identityProvider_identityProviderType :: Lens' IdentityProvider (Maybe IdentityProviderType) Source #

The identity provider type.

identityProvider_identityProviderArn :: Lens' IdentityProvider Text Source #

The ARN of the identity provider.