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.CreateIdentityProvider

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an identity provider resource that is then associated with a web portal.

Synopsis

Creating a Request

data CreateIdentityProvider Source #

See: newCreateIdentityProvider smart constructor.

Constructors

CreateIdentityProvider'

Fields

clientToken :: Maybe Text
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.
identityProviderDetails :: 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 (boolean) optional
identityProviderName :: Sensitive Text
The identity provider name.
identityProviderType :: IdentityProviderType
The identity provider type.
portalArn :: Text
The ARN of the web portal.

Instances

Instances details

ToJSON CreateIdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateIdentityProvider Methods toJSON :: CreateIdentityProvider -> Value # toEncoding :: CreateIdentityProvider -> Encoding # toJSONList :: [CreateIdentityProvider] -> Value # toEncodingList :: [CreateIdentityProvider] -> Encoding #
ToHeaders CreateIdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateIdentityProvider Methods toHeaders :: CreateIdentityProvider -> [Header] #
ToPath CreateIdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateIdentityProvider Methods toPath :: CreateIdentityProvider -> ByteString #
ToQuery CreateIdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateIdentityProvider Methods toQuery :: CreateIdentityProvider -> QueryString #
AWSRequest CreateIdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateIdentityProvider Associated Types type AWSResponse CreateIdentityProvider # Methods request :: (Service -> Service) -> CreateIdentityProvider -> Request CreateIdentityProvider # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateIdentityProvider -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateIdentityProvider))) #
Generic CreateIdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateIdentityProvider Associated Types type Rep CreateIdentityProvider :: Type -> Type # Methods from :: CreateIdentityProvider -> Rep CreateIdentityProvider x # to :: Rep CreateIdentityProvider x -> CreateIdentityProvider #
Show CreateIdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateIdentityProvider Methods showsPrec :: Int -> CreateIdentityProvider -> ShowS # show :: CreateIdentityProvider -> String # showList :: [CreateIdentityProvider] -> ShowS #
NFData CreateIdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateIdentityProvider Methods rnf :: CreateIdentityProvider -> () #
Eq CreateIdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateIdentityProvider Methods (==) :: CreateIdentityProvider -> CreateIdentityProvider -> Bool # (/=) :: CreateIdentityProvider -> CreateIdentityProvider -> Bool #
Hashable CreateIdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateIdentityProvider Methods hashWithSalt :: Int -> CreateIdentityProvider -> Int # hash :: CreateIdentityProvider -> Int #
type AWSResponse CreateIdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateIdentityProvider type AWSResponse CreateIdentityProvider = CreateIdentityProviderResponse
type Rep CreateIdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateIdentityProvider type Rep CreateIdentityProvider = D1 ('MetaData "CreateIdentityProvider" "Amazonka.WorkSpacesWeb.CreateIdentityProvider" "amazonka-workspaces-web-2.0-7elUOg7oNE07CClY3TuUcU" 'False) (C1 ('MetaCons "CreateIdentityProvider'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "identityProviderDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "identityProviderName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :: (S1 ('MetaSel ('Just "identityProviderType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IdentityProviderType) :: S1 ('MetaSel ('Just "portalArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateIdentityProvider Source #

Arguments

:: Text	`CreateIdentityProvider`
-> IdentityProviderType	`CreateIdentityProvider`
-> Text	`CreateIdentityProvider`
-> CreateIdentityProvider

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 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 (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 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 (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.

Constructors

CreateIdentityProviderResponse'
Fields httpStatus :: Int The response's http status code. identityProviderArn :: Text The ARN of the identity provider.

Instances

Instances details

Generic CreateIdentityProviderResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateIdentityProvider Associated Types type Rep CreateIdentityProviderResponse :: Type -> Type # Methods from :: CreateIdentityProviderResponse -> Rep CreateIdentityProviderResponse x # to :: Rep CreateIdentityProviderResponse x -> CreateIdentityProviderResponse #
Read CreateIdentityProviderResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateIdentityProvider Methods readsPrec :: Int -> ReadS CreateIdentityProviderResponse # readList :: ReadS [CreateIdentityProviderResponse] # readPrec :: ReadPrec CreateIdentityProviderResponse # readListPrec :: ReadPrec [CreateIdentityProviderResponse] #
Show CreateIdentityProviderResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateIdentityProvider Methods showsPrec :: Int -> CreateIdentityProviderResponse -> ShowS # show :: CreateIdentityProviderResponse -> String # showList :: [CreateIdentityProviderResponse] -> ShowS #
NFData CreateIdentityProviderResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateIdentityProvider Methods rnf :: CreateIdentityProviderResponse -> () #
Eq CreateIdentityProviderResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.CreateIdentityProvider Methods (==) :: CreateIdentityProviderResponse -> CreateIdentityProviderResponse -> Bool # (/=) :: CreateIdentityProviderResponse -> CreateIdentityProviderResponse -> Bool #
type Rep CreateIdentityProviderResponse Source #
Instance details 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 #

Arguments

:: Int	`$sel:httpStatus:CreateIdentityProviderResponse'`
-> Text	`CreateIdentityProviderResponse`
-> CreateIdentityProviderResponse

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.