AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DirectoryService::Types::EnableSsoRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing EnableSsoRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  directory_id: "DirectoryId", # required
  user_name: "UserName",
  password: "ConnectPassword",
}

Contains the inputs for the EnableSso operation.

Instance Attribute Summary collapse

Instance Attribute Details

#directory_idString

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

Returns:

  • (String)

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

#passwordString

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.

Returns:

  • (String)

    The password of an alternate account to use to enable single-sign on.

#user_nameString

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.

Returns:

  • (String)

    The username of an alternate account to use to enable single-sign on.