Sun OpenSSO Enterprise 8.0 C API Reference for Application and Web Policy Agent Developers


The Sun OpenSSO Enterprise 8.0 C API Reference provides a listing of application programming interfaces (API) you can use to enable C applications to access the Sun OpenSSO Enterprise components. The C API Reference includes function descriptions and syntax.

Who Should Use This Book

The C API Reference is intended for use by IT professionals, network administrators and software developers who implement a network access platform using Sun servers and software. It is recommended that readers of this guide are familiar with the following technologies:

Related Documentation

Related documentation is available as follows:

OpenSSO Enterprise 8.0 Core Documentation

The OpenSSO Enterprise 8.0 core documentation set contains the following titles:

Updates to the Release Notes and links to modifications of the core documentation can be found on the OpenSSO Enterprise page at Updated documents will be marked with a revision date.

Related Product Documentation

The following table provides links to documentation for related products.

Table P–1 Related Product Documentation



Sun Java System Directory Server 6.3

Sun Java System Web Server 7.0 Update 3

Sun Java System Application Server 9.1

Sun Java System Message Queue 4.1

Sun Java System Web Proxy Server 4.0.6

Sun Java System Identity Manager 7.1

Searching Sun Product Documentation

Besides searching Sun product documentation from the docs.sun.comSM web site, you can use a search engine by typing the following syntax in the search field:


For example, to search for “broker,” type the following:


To include other Sun web sites in your search (for example,,, and, use in place of in the search field.

Documentation, Support, and Training

The Sun web site provides information about the following additional resources:

Third-Party Web Site References

Third-party URLs are referenced in this document and provide additional, related information.

Note –

Sun is not responsible for the availability of third-party web sites mentioned in this document. Sun does not endorse and is not responsible or liable for any content, advertising, products, or other materials that are available on or through such sites or resources. Sun will not be responsible or liable for any actual or alleged damage or loss caused or alleged to be caused by or in connection with use of or reliance on any such content, goods, or services that are available on or through such sites or resources.

Sun Welcomes Your Comments

Sun is interested in improving its documentation and welcomes your comments and suggestions. To share your comments, go to and click Send Comments. In the online form, provide the full document title and part number. The part number is a 7-digit or 9-digit number that can be found on the book's title page or in the document's URL. For example, the title of this book is Sun OpenSSO Enterprise 8.0 Technical Overview, and the part number is 820–3740.

Typographical Conventions

The following table describes the typographic conventions that are used in this deployment example.

Table P–2 Typographic Conventions





The names of commands, files, and directories, and onscreen computer output 

Edit your .login file.

Use ls -a to list all files.

machine_name% you have mail.


What you type, contrasted with onscreen computer output 

machine_name% su



Placeholder: replace with a real name or value 

The command to remove a file is rm filename.


Book titles, new terms, and terms to be emphasized 

Read Chapter 6 in the User's Guide.

A cache is a copy that is stored locally.

Do not save the file.

Note: Some emphasized items appear bold online.