Authentication Properties (Sun Java System Access Manager 7.1 C API Reference)

Sun Java System Access Manager 7.1 C API Reference

Authentication Properties

The following list of properties are used by the authentication API. Some are defined in the AMAgent.properties file and some are not. Those that are not defined can be added to the file so they do not have to be defined for each function call. For example, com.sun.am.auth.org.name, which identifies the organization from which you want to authenticate, can be added to AMAgent.properties.

Tip –

The web agent AMAgent.properties includes information for a variety of configurations. By default, the authentication API checks the directory where Access Manager is installed for AMAgent.properties. After installing Access Manager though, the file does not exist. If the file does not exist, you must create it and add these properties to the file. More information on AMAgent.properties can be found in Appendix C, Web Agent AMAgent.properties Configuration File, in Sun Java System Access Manager Policy Agent 2.2 Guide for Sun Java System Web Server 6.1.

Table 2–1 Properties Needed by the Authentication API for C


Property	Definition
`com.sun.am.naming.url`	URL of the Access Manager Naming Service in the format: `http://server.domain:port/amserver/namingservice`
`com.sun.am.policy.agents.config.local.log.file`	The logging directory in the format: `path-to-directory/logs/auth-log` Note – This property may be added to `AMAgent.properties`.
`com.sun.am.log.level`	The level at which logs are written in the format: `all:#` where `#` is the level 5 being the highest, 3 medium and 1 the lowest. More information can be found in `AMAgent.properties`.
`com.sun.am.sslcert.dir`	Path to the directory containing the certificate and key databases for Secure Sockets Layer (SSL).
`com.sun.am.certdb.prefix`	Set this property if the certificate databases in the directory specified by `com.sun.am.sslcert.dir` has a prefix.
`com.sun.am.certDBPassword=`	The password to the `key3.db` file. Note – This property may be added to `AMAgent.properties`.
`com.sun.am.trust_server_certs`	Defines whether or not to trust SSL certificates not defined in the certificate database. Takes a value of `true` or `false` where `true` enables trust.
`com.sun.am.auth.certificateAlias=`	The nick name of the client certificate in the `cert7.db`. Note – This property may be added to `AMAgent.properties`.
`com.sun.am.auth.org.name`	The Access Manager organization desired for authentication. The value is the root suffix of the organization using domain-component (dc) as in: `dc=sun,dc=com` Note – This property may be added to `AMAgent.properties`.