Classes

ACActiveSession describes a currently active IAMPASS session. Instances of this class are created in response to calls to IPUser.get_active_sessions. A session is considered active if the user has been authenticated and not logged out. ACActiveSession can be used to display and end a user’s sessions.

Undocumented

Represents the status of an IAMPASS session. The status property can be used to verify the state of the session. The refreshStatus method should be called to update the session status.

Defines the result of calling IPAuthenticationAPI.startAuthentication

IPAuthenticationAPI provides methods for initiating authentication requests.

Represents the content of an authentication request Push Notification. Client applications should not create instances directly but rely on IPNotificationHandler to create a populate the instance. IPAuthenticationRequest is passed to IPAuthenticationViewController, which will decode the content, present appropriate UI to collect data and send results to server.

The Management API provides utility methods for managing IAMPASS applications. The API is used for managing users.

IPNotification handler parses the content of a push notification and extracts IAMPASS information. If the push notification is an IAMPASSauthentication request the delegat’s presentAuthenticationUI is called with the decoded authentication request and the device that the request is for. The client should call the processNotification method when it receives a push notification.

Represents the status of an IAMPASS session. When the status of a session changes, IAMPASS sends a Push Notification to the application. IPNotificationHandler creates an instance of this class and calls its delegate with the session status. The application can update its UI to notify the user that the status of the session has change.

Class the represents an IAMPASS User. Instances of this class contain the information required to communicate with IAMPASS on behalf the of the device user. The client applicaton is responsible for storing the IPUser data for the user accounts registered with their app. IPUser data can be serialized as JSON and store/read from a secure location, for example the device key chain.

View controller for the the acceptance part of the authentication process. The IAMPASS Framework includes a default UI for this authentication stage. IPAcceptanceViewControllers are created by IPAuthenticationViewController. A custom UI can be provided by creating a nib file containing an IPAcceptanceViewController and set the values of IPAuthenticationViewController.acceptanceBundleIdentifier and IPAuthenticationViewController.acceptanceNibName.

View controller that controls the authentication process. The IAMPASS framework provides a default UI for all stages of the. Applications can provide their own UI but must use this class to control the authentication process. Customization is achieved by providing Bundle and Nib informtion for each of the screens. The custom views must be instances or specializations of IAMPASS view controller classes

Class used to display a ‘busy’ screen, which is displayed when the application is performing a lengthy task. Client applications can use this class to create a custom busy UI. Create a new view controller in Interface Builder, then set the Custom Class property to IPBusyViewController in the Identity Inspoector. The bundle identifier and nib containing the view can then be used with IPAuthenticationViewController.authenticatingBundleIdentifier and IPAuthenticationViewController.authenticatingNibName to display the view.

A view controller that collects images of the user’s face.

View controller for performing OS authentication. ACOSViewControllers are created by IPAuthenticationViewController. A custom UI can be provided by creating a nib file containing an IPOSViewController and set the values of IPAuthenticationViewController.osBundleIdentifier and IPAuthenticationViewController.osNibName.

View controller used to detect proximity when it is required by an Authentication Request. A custom UI can be provided by creating a nib file containing an IPProximityViewController and set the values of IPAuthenticationViewController.proximityBundleIdentifier and IPAuthenticationViewController.proximityNibName.

View controller that informs the user that training is required. IAMPASS includes a default UI for this view controller. A custom UI can be provided by creating a nib file containing an IPTrainingRequiredViewController and set the values of IPTrainingViewController.instructionsBundleIdentifier and IPTrainingViewController.instructionsNibName.

View controller used for the training process. The view controller has several views which are displayed depending upon the training that needs to be performed. In addition the following views are controller:

• Instructions view is displayed prior to training and a status view which displays the result
• Busy view is displayed while training data is being processed.
• Status view is displayed to report the result of the training process.