Skip to end of metadata
Go to start of metadata

The features of OpenIAM like authentication, provisioning, user management, organization, and authorization are available via API (Application Programming Interface). OpenIAM Identity Manager provides both SOAP and REST APIs to access IDM functionality outside the application. Both SOAP and REST architectures are generic and can be used from any programming language.

This section is intended to be used by developers implementing application integrated with IDM using SOAP API. The section contains API description and helpful API usage samples. All key web service methods have requests and response message samples supplied. Code samples for Java programming language are provided as well.

Introducing SOAP API

The SOAP API makes the functionality available by exposing interfaces for different remote applications and entry points. On the top of the services layer, new applications or new screens can be built. The API options provided by OpenIAM Identity Manager are intended for developers who need to integrate or embed the Identity Manager into another environment. The other purpose of using API services is adding of security functionality to your existing application.

The Identity Manager API is based on SOAP (Simple Object Access Protocol), which is the industry-standard for integrating web-services applications. SOAP API is implemented based on the following specifications:

Standard NameWebsite
Simple Object Access Protocol (SOAP) 1.1
Web Service Description Language (WSDL) 1.1
Development Platforms

SOAP API is available at development environment for integration and testing.

All provided samples are written in Java. However, implementation platform is not limited to Java. Other words any platform supporting SOAP 1.1 can be used. The SOAP API is generic, and can be used from most programming languages in addition to Java: Visual Basic, C, C#, Delphi, Perl, PHP and many more.


You can use soapUI (Copyright SmartBear Software) to create and execute automated functional, regression, compliance, and load tests. soapUI is a free, open-source, cross-platform functional testing solution. In a single test environment, soapUI provides complete test coverage and supports all standard protocols and technologies. You can download soapUI 4.5 open-source here: Read more:

WSDL Files

The WSDLs of the available services in OpenIAM can be found in this chapter.

Web Services Overview

The key services are used for:

  • Authentication
  • Provisioning
  • User Management
  • Organization
  • Authorization

Here is the list of web services:

  • ActivitiService
  • AsynchAuditDataService
  • AsynchGenericObjectSynchService
  • AsynchIdentitySynchService
  • AsynchReconciliationWebService
  • AsynchUserProvisionService
  • AuditService
  • AuthenticationService
  • AuthorizationManagerAdminWebService
  • AuthorizationManagerMenuWebService
  • AuthorizationManagerWebService
  • AuthorizationWebService
  • AuthProviderWebService
  • AuthResourceAttributeWebService
  • BatchDataWebService
  • CategoryWebService
  • ChallengeResponseWebService
  • ContentProviderWebService
  • EmailWebService
  • FileWebService
  • GenericObjectSynchWebService
  • GroupDataWebService
  • HeartBeatService
  • IdentitySynchWebService
  • KeyManagementWS
  • LanguageWebService
  • LocationDataWebService
  • LoginDataWebService
  • MailTemplateWebService
  • ManagedSystemWebService
  • MetadataElementTemplateWebService
  • MetadataWebService
  • OrganizationDataWebService
  • OrgPolicyWebService
  • PasswordWebService
  • PolicyWebService
  • ProvisionControllerService
  • ProvisioningService
  • PublishAuditEventService
  • QueryDataWebService
  • ReconciliationWebService
  • ReferenceDataWebService
  • ReportService
  • RequestWebService
  • ResourceDataWebService
  • RoleDataWebService
  • SecurityDomainWebService
  • SysMessageWebService
  • SystemInfoWebService
  • URIFederationWebService
  • UserDataWebService
  • WebResourceService

Java Documentation

You can access the API Reference Documentation. The documentation is a set of JavaDocs for the v3 service layer, it describes classes and their methods.

JavaDocs Links


In the Current Section...