OTIS Documentation

Overview

The OTIS client SDK is a Java SDK that an application can use to access OTIS identity services. The client SDK can be configured to talk directly using a local implementation, or it can be configured to send requests over a RESTful protocol to an OTIS server. Both the local and remote implementations of OTIS rely upon Higgins IdAS Context Providers for access to identity information.

For more information on the OTIS client SDK and the OTIS server, including a more detailed introduction and a comprehensive architecture, see the Onramp to Identity Service (OTIS) page.

Deploying an OTIS Server

An OTIS server is not required, but it has significant advantages in managing Security, gaining accessibility via clients other than our Java SDK, and deploying the client.

1. Deploying an OTIS Server
   1. Downloading or Creating a .war File
      1. Downloading a .war File
      2. Creating Your Own .war File
   2. Deploying OTIS
      1. Quickstart
         1. Standalone Glassfish Deployment
         2. Simple Pre-configured Deployment
      2. Deploying As a Tomcat Application On Linux
         1. Apache Connector
         2. Java 1.6 or Later
         3. Enabling Strong Encryption
         4. Miscellaneous Issues
   3. Configuring OTIS
      1. web.xml
      2. otis-config.server.xml
      3. otis-config.client.local.xml
   4. A Simple LDAP Deployment
      1. Username to DN Mapping
      2. The JSSharedScope Setting
      3. Entity Type to Object Class Name Mapping
      4. Attribute Name Mapping
      5. Attribute Value Mapping

Developer Documentation

OTIS Functionality

Below is the list of functions provided by OTIS for application developers. Each link in the list explains how a developer would use the function in an application. It also provides sample code snippets for Java, REST, PHP, and cURL. Links to more comprehensive sample code are provided in the next section, "Java and PHP Sample Code."

1. Entity and Attribute Tasks
   1. Create Attribute
   2. Create Entity
   3. Delete Attribute
   4. Delete Entity
   5. Read Attribute
   6. Read Context
   7. Read Entity
   8. Update Attribute
   9. Update Entity
2. Audit Tasks
   1. Log Audit Record
3. Authentication Tasks
   1. Authenticate User
   2. Creating a Custom Authentication Method
   3. Log Out Authenticated User
   4. Read Authenticated Entity
   5. Reauthenticate User
4. Role Tasks
   1. Activate Role
   2. Get Active Roles
   3. Get Assumable Roles
   4. Is In Role
   5. Release Role
5. Session Tasks
   1. Get Session Property
   2. Remove Session Property
   3. Set Session Property

NOTE: The OTIS client library can be downloaded from the OTIS download page.

Samples

1. Accepting Access Manager SAML Assertions
2. External Role Sample
3. Roles from JSON Sample
4. Authentication and Roles Java Sample Code
5. Entity/Attribute Java Sample Code
6. A First Look At the OTIS SDK
7. Authentication and Roles PHP Sample Code
8. Entity/Attribute PHP Sample Code

OTIS RESTful Protocol Details

1. OTIS Restful Protocol Overview
   1. Notational Conventions
   2. Authenticated Session Secret
   3. Specifying a Version for Resources
   4. Authentication Nouns
   5. Role Nouns
   6. Attribute/Entity Nouns
   7. Audit Log Nouns
   8. Session Properties Nouns

Audit Logging

1. Audit Logging
   1. Built-in Audit Logging
   2. Audit Logging APIs

Configuration Documentation

Both the OTIS client and the OTIS server have extensive configuration settings that allow great flexibility in determining authentication methods, identity stores to be accessed, role policy, and so forth. Much of the power of OTIS is found in the ability to configure them in a variety of ways. However, configuration can be a daunting task for the beginner. The topics listed below help an administrator or developer understand how to perform configuration tasks.

Understand that the OTIS client SDK is a Java SDK. Nearly all of the interfaces defined there have configure methods (or equivalents) that take java.util.Map objects as a configuration parameter. Developers can create such Map objects in any way that suits them, including reading the configuration from any number of file formats (XML, JSON, name/value pair, and so forth) and producing the Map. In this configuration documentation, settings are documented using a specific XML file format. Java classes are also provided for reading configuration from this format. The OTIS server is always configured from an XML file in this format. Therefore, it might be helpful to start by reading the documentation on this format (see "XML File Configuration Format" topic below). After that, reading the topic "Configuring OTIS Client in Java" might be helpful for an application developer using the OTIS client SDK. The rest of the topics cover specific settings for the OTIS client, the OTIS server, and so forth. A good starting point for getting into specific settings is the "Configuration Settings for OTIS Client" topic, followed by the "Configuration Settings For an OTIS Server" topic.

1. Context Provider Configuration
   1. Configuration Settings for IdAS Registry
   2. Configuration Settings for JNDI Context Provider
   3. Configuration Settings for JSON Context Provider
   4. Configuration Settings for JSPolicy Context Provider
   5. Configuration Settings for XML File Context Provider
2. General OTIS Configuration
   1. Security Administrator's Guide
   2. XML File Configuration Format
   3. Configuring OTIS Client in Java
   4. Configuration Settings for OTIS Client
   5. Configuration Settings for OTIS Server
   6. Configuration Settings for Specific Authentication Methods
3. Configuration Settings for Roles
   1. Configuration Settings for Activate Role
   2. Configuration Settings for Activate Role at Authentication
   3. Configuration Settings for Get Assumable Roles
   4. Configuration Settings for Provision/Deprovision Entity in Role
   5. Configuration Settings for Release Role