Sun OpenSSO Enterprise 8.0 Administration Reference

Authentication Service Management

The following subcommands execute operations for the OpenSSO Enterprise Authentication service.

add-auth-cfg-entr

Add an authentication configuration entry.

Syntax

ssoadm add-auth-cfg-entr --options [--global-options]

Options

--realm, -e

The name of the realm.

--name, -m

The name of the authentication configuration.

--modulename, -o

The module name.

--criteria, -c

The criteria for this entry. Possible values are REQUIRED, OPTIONAL, SUFFICIENT, and REQUISITE.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

[--options, -t]

The options for this entry.

[--position, -p]

The position where the new entry is to be added.

create-auth-cfg

Create an authentication configuration.

Syntax

ssoadm create-auth-cfg --options [--global-options]

Options

--realm, -e

The name of the realm.

--name, -m

The name of the authentication configuration.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

create-auth-instance

Create an authentication instance.

Syntax

ssoadm create-auth-instance --options [--global-options]

Options

--realm, -e

The name of the realm.

--name, -m

The name of the authentication instance.

--authtype, -t

The type of authentication instance. For example LDAP or DataStore.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

delete-auth-cfgs

Delete existing authentication configurations.

Syntax

ssoadm delete-auth-cfgs --options [--global-options]

Options

--realm, -e

The name of the realm.

--names, -m

The names of the authentication configurations.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

delete-auth-instances

Delete existing authentication instances.

Syntax

ssoadm delete-auth-instances --options [--global-options]

Options

--realm, -e

The name of the realm.

--names, -m

The names of the authentication instances.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

get-auth-cfg-entr

Get the authentication configuration entries.

Syntax

ssoadm get-auth-cfg-entr --options [--global-options]

Options

--realm, -e

The name of the realm.

--name, -m

The name of the authentication configuration.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

get-auth-instance

Get the authentication instance values.

Syntax

ssoadm get-auth-instance --options [--global-options]

Options

--realm, -e

The name of the realm.

--name, -m

The name of the authentication instance.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

list-auth-cfgs

List the authentication configurations.

Syntax

ssoadm list-auth-cfgs --options [--global-options]

Options

--realm, -e

The name of the realm.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

list-auth-instances

List the authentication instances.

Syntax

ssoadm list-auth-instances --options [--global-options]

Options

--realm, -e

The name of the realm.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

register-auth-module

Register an authentication module.

Syntax

ssoadm register-auth-module --options [--global-options]

Options

--authmodule, -a

The Java class name of the authentication module.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

unregister-auth-module

Unregister the authentication module.

Syntax

ssoadm unregister-auth-module --options [--global-options]

Options

--authmodule, -a

The Java class name of the authentication module.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

update-auth-cfg-entr

Set the authentication configuration entries.

Syntax

ssoadm update-auth-cfg-entr --options [--global-options]

Options

--realm, -e

The name of the realm.

--name, -m

The name of the authentication configuration.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

[--entries, -a]

The formatted authentication configuration entries.

[--datafile, -D]

The filename that contains the formatted authentication configuration entries. Enter one attribute-name=attribute-value per line.

update-auth-instance

Update the authentication instance values.

Syntax

ssoadm update-auth-instance --options [--global-options]

Options

--realm, -e

The name of the realm.

--name, -m

The name of the authentication instance.

--adminid, -u

The administrator ID running the command.

--password-file, -f

The filename that contains the password of the administrator.

[--attributevalues, -a]

The attribute values. For example, homeaddress=here.

[--datafile, -D]

Name of file that contains attributes and corresponding values as in attribute-name=attribute-value. Enter one attribute and value per line.