Copyright	(c) 2013-2021 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

Amazonka.DirectoryService.EnableSso

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Enables single sign-on for a directory. Single sign-on allows users in your directory to access certain Amazon Web Services services from a computer joined to the directory without having to enter their credentials separately.

Synopsis

data EnableSso = EnableSso' {
- userName :: Maybe Text
- password :: Maybe (Sensitive Text)
- directoryId :: Text
}
newEnableSso :: Text -> EnableSso
enableSso_userName :: Lens' EnableSso (Maybe Text)
enableSso_password :: Lens' EnableSso (Maybe Text)
enableSso_directoryId :: Lens' EnableSso Text
data EnableSsoResponse = EnableSsoResponse' {
- httpStatus :: Int
}
newEnableSsoResponse :: Int -> EnableSsoResponse
enableSsoResponse_httpStatus :: Lens' EnableSsoResponse Int

Creating a Request

data EnableSso Source #

Contains the inputs for the EnableSso operation.

See: newEnableSso smart constructor.

Constructors

EnableSso'

Fields

userName :: Maybe Text
The username of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. This account must have privileges to add a service principal name.
If the AD Connector service account does not have privileges to add a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to enable single sign-on and are not stored by the service. The AD Connector service account is not changed.
password :: Maybe (Sensitive Text)
The password of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter.
directoryId :: Text
The identifier of the directory for which to enable single-sign on.

Instances

Instances details

Eq EnableSso Source #
Instance details Defined in Amazonka.DirectoryService.EnableSso Methods (==) :: EnableSso -> EnableSso -> Bool # (/=) :: EnableSso -> EnableSso -> Bool #
Show EnableSso Source #
Instance details Defined in Amazonka.DirectoryService.EnableSso Methods showsPrec :: Int -> EnableSso -> ShowS # show :: EnableSso -> String # showList :: [EnableSso] -> ShowS #
Generic EnableSso Source #
Instance details Defined in Amazonka.DirectoryService.EnableSso Associated Types type Rep EnableSso :: Type -> Type # Methods from :: EnableSso -> Rep EnableSso x # to :: Rep EnableSso x -> EnableSso #
NFData EnableSso Source #
Instance details Defined in Amazonka.DirectoryService.EnableSso Methods rnf :: EnableSso -> () #
Hashable EnableSso Source #
Instance details Defined in Amazonka.DirectoryService.EnableSso Methods hashWithSalt :: Int -> EnableSso -> Int # hash :: EnableSso -> Int #
ToJSON EnableSso Source #
Instance details Defined in Amazonka.DirectoryService.EnableSso Methods toJSON :: EnableSso -> Value # toEncoding :: EnableSso -> Encoding # toJSONList :: [EnableSso] -> Value # toEncodingList :: [EnableSso] -> Encoding #
AWSRequest EnableSso Source #
Instance details Defined in Amazonka.DirectoryService.EnableSso Associated Types type AWSResponse EnableSso # Methods request :: EnableSso -> Request EnableSso # response :: MonadResource m => Logger -> Service -> Proxy EnableSso -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse EnableSso))) #
ToHeaders EnableSso Source #
Instance details Defined in Amazonka.DirectoryService.EnableSso Methods toHeaders :: EnableSso -> [Header] #
ToPath EnableSso Source #
Instance details Defined in Amazonka.DirectoryService.EnableSso Methods toPath :: EnableSso -> ByteString #
ToQuery EnableSso Source #
Instance details Defined in Amazonka.DirectoryService.EnableSso Methods toQuery :: EnableSso -> QueryString #
type Rep EnableSso Source #
Instance details Defined in Amazonka.DirectoryService.EnableSso type Rep EnableSso = D1 ('MetaData "EnableSso" "Amazonka.DirectoryService.EnableSso" "libZSservicesZSamazonka-dsZSamazonka-ds" 'False) (C1 ('MetaCons "EnableSso'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse EnableSso Source #
Instance details Defined in Amazonka.DirectoryService.EnableSso type AWSResponse EnableSso = EnableSsoResponse

newEnableSso Source #

Arguments

:: Text	`$sel:directoryId:EnableSso'`
-> EnableSso

Create a value of EnableSso 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:userName:EnableSso', enableSso_userName - The username of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. This account must have privileges to add a service principal name.

If the AD Connector service account does not have privileges to add a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to enable single sign-on and are not stored by the service. The AD Connector service account is not changed.

$sel:password:EnableSso', enableSso_password - The password of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter.

$sel:directoryId:EnableSso', enableSso_directoryId - The identifier of the directory for which to enable single-sign on.

Request Lenses

enableSso_userName :: Lens' EnableSso (Maybe Text) Source #

The username of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. This account must have privileges to add a service principal name.

If the AD Connector service account does not have privileges to add a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to enable single sign-on and are not stored by the service. The AD Connector service account is not changed.

enableSso_password :: Lens' EnableSso (Maybe Text) Source #

The password of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter.

enableSso_directoryId :: Lens' EnableSso Text Source #

The identifier of the directory for which to enable single-sign on.

Destructuring the Response

data EnableSsoResponse Source #

Contains the results of the EnableSso operation.

See: newEnableSsoResponse smart constructor.

Constructors

EnableSsoResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Eq EnableSsoResponse Source #
Instance details Defined in Amazonka.DirectoryService.EnableSso Methods (==) :: EnableSsoResponse -> EnableSsoResponse -> Bool # (/=) :: EnableSsoResponse -> EnableSsoResponse -> Bool #
Read EnableSsoResponse Source #
Instance details Defined in Amazonka.DirectoryService.EnableSso Methods readsPrec :: Int -> ReadS EnableSsoResponse # readList :: ReadS [EnableSsoResponse] # readPrec :: ReadPrec EnableSsoResponse # readListPrec :: ReadPrec [EnableSsoResponse] #
Show EnableSsoResponse Source #
Instance details Defined in Amazonka.DirectoryService.EnableSso Methods showsPrec :: Int -> EnableSsoResponse -> ShowS # show :: EnableSsoResponse -> String # showList :: [EnableSsoResponse] -> ShowS #
Generic EnableSsoResponse Source #
Instance details Defined in Amazonka.DirectoryService.EnableSso Associated Types type Rep EnableSsoResponse :: Type -> Type # Methods from :: EnableSsoResponse -> Rep EnableSsoResponse x # to :: Rep EnableSsoResponse x -> EnableSsoResponse #
NFData EnableSsoResponse Source #
Instance details Defined in Amazonka.DirectoryService.EnableSso Methods rnf :: EnableSsoResponse -> () #
type Rep EnableSsoResponse Source #
Instance details Defined in Amazonka.DirectoryService.EnableSso type Rep EnableSsoResponse = D1 ('MetaData "EnableSsoResponse" "Amazonka.DirectoryService.EnableSso" "libZSservicesZSamazonka-dsZSamazonka-ds" 'False) (C1 ('MetaCons "EnableSsoResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newEnableSsoResponse Source #

Arguments

:: Int	`$sel:httpStatus:EnableSsoResponse'`
-> EnableSsoResponse

Create a value of EnableSsoResponse 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:EnableSsoResponse', enableSsoResponse_httpStatus - The response's http status code.

Response Lenses

enableSsoResponse_httpStatus :: Lens' EnableSsoResponse Int Source #

The response's http status code.