Amazonka.DirectoryService.EnableSso

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.

Creating a Request

data EnableSso

Contains the inputs for the EnableSso operation.

See: newEnableSso smart constructor.

Constructors

EnableSso'

Fields

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

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

• directoryId :: Text

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

Instances

ToJSON EnableSso

Defined in Amazonka.DirectoryService.EnableSso

Methods

toJSON :: EnableSso -> Value

toEncoding :: EnableSso -> Encoding

toJSONList :: [EnableSso] -> Value

toEncodingList :: [EnableSso] -> Encoding

ToHeaders EnableSso

Defined in Amazonka.DirectoryService.EnableSso

Methods

toHeaders :: EnableSso -> [Header]

ToPath EnableSso

Defined in Amazonka.DirectoryService.EnableSso

Methods

toPath :: EnableSso -> ByteString

ToQuery EnableSso

Defined in Amazonka.DirectoryService.EnableSso

Methods

toQuery :: EnableSso -> QueryString

AWSRequest EnableSso

Defined in Amazonka.DirectoryService.EnableSso

Associated Types

type AWSResponse EnableSso

Methods

request :: (Service -> Service) -> EnableSso -> Request EnableSso

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy EnableSso -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse EnableSso)))

Generic EnableSso

Defined in Amazonka.DirectoryService.EnableSso

Associated Types

type Rep EnableSso :: Type -> Type

Methods

from :: EnableSso -> Rep EnableSso x

to :: Rep EnableSso x -> EnableSso

Show EnableSso

Defined in Amazonka.DirectoryService.EnableSso

Methods

showsPrec :: Int -> EnableSso -> ShowS

show :: EnableSso -> String

showList :: [EnableSso] -> ShowS

NFData EnableSso

Defined in Amazonka.DirectoryService.EnableSso

Methods

rnf :: EnableSso -> ()

Eq EnableSso

Defined in Amazonka.DirectoryService.EnableSso

Methods

(==) :: EnableSso -> EnableSso -> Bool

(/=) :: EnableSso -> EnableSso -> Bool

Hashable EnableSso

Defined in Amazonka.DirectoryService.EnableSso

Methods

hashWithSalt :: Int -> EnableSso -> Int

hash :: EnableSso -> Int

type AWSResponse EnableSso

Defined in Amazonka.DirectoryService.EnableSso

type AWSResponse EnableSso = EnableSsoResponse

type Rep EnableSso

Defined in Amazonka.DirectoryService.EnableSso

type Rep EnableSso = D1 ('MetaData "EnableSso" "Amazonka.DirectoryService.EnableSso" "amazonka-ds-2.0-AgXI5fcN8ZxCoi4kNvhD3" 'False) (C1 ('MetaCons "EnableSso'" 'PrefixI 'True) (S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: (S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newEnableSso

Arguments

:: Text

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

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

Request Lenses

enableSso_password :: Lens' EnableSso (Maybe 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.

enableSso_userName :: Lens' EnableSso (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.

enableSso_directoryId :: Lens' EnableSso Text

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

Destructuring the Response

data EnableSsoResponse

Contains the results of the EnableSso operation.

See: newEnableSsoResponse smart constructor.

Constructors

EnableSsoResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic EnableSsoResponse

Defined in Amazonka.DirectoryService.EnableSso

Associated Types

type Rep EnableSsoResponse :: Type -> Type

Methods

from :: EnableSsoResponse -> Rep EnableSsoResponse x

to :: Rep EnableSsoResponse x -> EnableSsoResponse

Read EnableSsoResponse

Defined in Amazonka.DirectoryService.EnableSso

Methods

readsPrec :: Int -> ReadS EnableSsoResponse

readList :: ReadS [EnableSsoResponse]

readPrec :: ReadPrec EnableSsoResponse

readListPrec :: ReadPrec [EnableSsoResponse]

Show EnableSsoResponse

Defined in Amazonka.DirectoryService.EnableSso

Methods

showsPrec :: Int -> EnableSsoResponse -> ShowS

show :: EnableSsoResponse -> String

showList :: [EnableSsoResponse] -> ShowS

NFData EnableSsoResponse

Defined in Amazonka.DirectoryService.EnableSso

Methods

rnf :: EnableSsoResponse -> ()

Eq EnableSsoResponse

Defined in Amazonka.DirectoryService.EnableSso

Methods

(==) :: EnableSsoResponse -> EnableSsoResponse -> Bool

(/=) :: EnableSsoResponse -> EnableSsoResponse -> Bool

type Rep EnableSsoResponse

Defined in Amazonka.DirectoryService.EnableSso

type Rep EnableSsoResponse = D1 ('MetaData "EnableSsoResponse" "Amazonka.DirectoryService.EnableSso" "amazonka-ds-2.0-AgXI5fcN8ZxCoi4kNvhD3" 'False) (C1 ('MetaCons "EnableSsoResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newEnableSsoResponse

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

The response's http status code.