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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb

Overview

Note:

When making an API call, you may pass EnableSsoRequest data as a 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)


1797
1798
1799
1800
1801
1802
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1797

class EnableSsoRequest < Struct.new(
  :directory_id,
  :user_name,
  :password)
  include Aws::Structure
end

#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)


1797
1798
1799
1800
1801
1802
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1797

class EnableSsoRequest < Struct.new(
  :directory_id,
  :user_name,
  :password)
  include Aws::Structure
end

#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)


1797
1798
1799
1800
1801
1802
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1797

class EnableSsoRequest < Struct.new(
  :directory_id,
  :user_name,
  :password)
  include Aws::Structure
end