One Identity Manager 10.

API Development Guide

Copyright 2025 One Identity LLC.
ALL RIGHTS RESERVED.
This guide contains proprietary information protected by copyright. The software described in this
guide is furnished under a software license or nondisclosure agreement. This software may be used
or copied only in accordance with the terms of the applicable agreement. No part of this guide may
be reproduced or transmitted in any form or by any means, electronic or mechanical, including
photocopying and recording for any purpose other than the purchaser’s personal use without the
written permission of One Identity LLC .
The information in this document is provided in connection with One Identity products. No license,
express or implied, by estoppel or otherwise, to any intellectual property right is granted by this
document or in connection with the sale of One Identity LLC products. EXCEPT AS SET FORTH IN THE
TERMS AND CONDITIONS AS SPECIFIED IN THE LICENSE AGREEMENT FOR THIS PRODUCT,
ONE IDENTITY ASSUMES NO LIABILITY WHATSOEVER AND DISCLAIMS ANY EXPRESS, IMPLIED OR
STATUTORY WARRANTY RELATING TO ITS PRODUCTS INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-
INFRINGEMENT. IN NO EVENT SHALL ONE IDENTITY BE LIABLE FOR ANY DIRECT, INDIRECT,
CONSEQUENTIAL, PUNITIVE, SPECIAL OR INCIDENTAL DAMAGES (INCLUDING, WITHOUT
LIMITATION, DAMAGES FOR LOSS OF PROFITS, BUSINESS INTERRUPTION OR LOSS OF
INFORMATION) ARISING OUT OF THE USE OR INABILITY TO USE THIS DOCUMENT, EVEN IF
ONE IDENTITY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. One Identity makes
no representations or warranties with respect to the accuracy or completeness of the contents of this
document and reserves the right to make changes to specifications and product descriptions at any
time without notice. One Identity does not make any commitment to update the information
contained in this document.
If you have any questions regarding your potential use of this material, contact:
One Identity LLC.
Attn: LEGAL Dept
4 Polaris Way
Aliso Viejo, CA 92656
Refer to our website ([Link] for regional and international office information.
Patents
One Identity is proud of our advanced technology. Patents and pending patents may apply to this
product. For the most current information about applicable patents for this product, please visit our
website at [Link]
Trademarks
One Identity and the One Identity logo are trademarks and registered trademarks of One Identity
LLC. in the U.S.A. and other countries. For a complete list of One Identity trademarks, please visit
our website at [Link]/legal/[Link]. All other trademarks are
the property of their respective owners.
Legend

WARNING: A WARNING icon highlights a potential risk of bodily injury or property damage,
for which industry-standard safety precautions are advised. This icon is often associated with
electrical hazards related to hardware.

CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if

instructions are not followed.

One Identity Manager API Development Guide

Updated - 05 December 2025, 11:25
For the most recent documents and product information, see Online product documentation.
Contents

Developing APIs 5

Basic principles of API development 6

API Server basics 6
General information about the API Server 6
Calling the API Server web interface 6
Encryption 7
General notes on programming your own API methods 7
Automatic checking of API route uniqueness 8
Guidelines and conventions 8
Handling API Server requests 8
API methods 9
Entity methods 10
User-defined methods 17
SQL methods 18
WebSocket methods 18
Response codes 18
Response formats 19
Authentication 19
Configuring authentication 20
Authentication (primary) 20
Logging out 21
Defining custom error messages 21
Date formats 21
Avoiding deadlocks 22
Querying API Server reachability 22
HTTP methods 22
Parameter formats 22
Path parameters 22
Query parameters 23
Session status and security tokens 23
Querying session status 23

One Identity Manager 10.0 API Development Guide

3
 Language 24

Examples and help – Software Development Kit 25

Implementing your own APIs 26

Managing API plugins 26
Creating API plugins 26
Editing API plugins 27
Compiling TypeScript API clients 28
Adding APIs to One Identity API projects 29
Creating API projects 30
Adding APIs to your own API projects 31

ImxClient command line program 32

Starting the ImxClient command line program 32
ImxClient command overview 32
check-translations 32
compile-api 33
compile-app 34
connect 35
edit-config 36
fetch-files 36
get-filestate 37
help 38
inject-package 38
install-apiserver 39
push-files 40
repl 41
run-apiserver 41
start-update 43
workspace-info 43

About us 44
Contacting us 44
Technical support resources 44

Index 45

One Identity Manager 10.0 API Development Guide

4
 Developing APIs

This guide explains the API Server's functionality, how you program API calls, and add your
own API methods to One Identity Manager.

Available documentation

The online version of One Identity Manager documentation is available in the Support
portal under Technical Documentation. You will find videos with additional information at
[Link]/OneIdentity.

One Identity Manager 10.0 API Development Guide

5
Developing APIs
 1

Basic principles of API development

Web applications use the API Client to communicate with the One Identity Manager API.
The API Client controls all network access on the API Server.
The most important components for developing your own APIs are:
l API projects: An API project represents the actual application and provides API
methods. Various API projects are supplied with One Identity Manager, for example
the Web Portal (portal).
l API plugins: An API plugin serves as a container for custom extensions. With an API
plugin, you can deploy your own API projects and/or add more API methods to
existing API projects.
l API Provider: An API provider is a single class in a DLL file that declares API methods.

API Server basics

In this chapter you will find basic information about the API Servers architecture, which is
important for developing your own API methods.

General information about the API Server

l The API Server deploys the API.
l The API Server is implemented using the Owin Platform (see [Link]
l URLs are case sensitive.

Calling the API Server web interface

From the API Server's web interface you can:

One Identity Manager 10.0 API Development Guide

6
Basic principles of API development
 l Open the Web Portal.
l Open the Password Reset Portal.
l Open the Operations Support Web Portal.
l Open the Administration Portal to configure the API Server and the web applications
l Open all other installed web applications

To call the API Server web interface

l In a web browser, open the webpage (URL) of your API Server.

Encryption
The API Server stores data securely encrypted on the client.
The certificate is configured when the API server is installed on the IIS.
For more information, see Installing and updating an API Server.
For more information, see Changing encryption.

General notes on programming your own

API methods
l Because the API Server is stateless, save the API methods without a client
specific state.
For example, you cannot, therefore, define global variables or store session
object status data. When the API Server processes are restarted, these values
are not restored.
l After enabling routes, you cannot change the definition objects anymore.
l Use asynchronous code for defining API methods. This supports more efficient
usage of server resources and improves performance of the system under load. The
methods of the API and the underlying object model convert this asynchronously
using the Task-based Asynchronous Pattern (TAP). For more information about
TAP, see here.
l Do not use the [Link] method when you define API methods.
You can query the current HTTP requirements with the
[Link] static
method.
l If you define API methods that modify data, do NOT use the GET method.
l API methods are deployed via [Link] Core. You can use route templates to define
how an HTTP request is assigned to a corresponding API method. The syntax for

One Identity Manager 10.0 API Development Guide

7
Basic principles of API development
 route templates is specified by [Link] Core. For more information about route
templates, see here.

Automatic checking of API route uniqueness

The API Server automatically checks at the start whether API routing is unique. The
moment the API Server discovers that non-unique URL patterns were registered, an error
message with the ApiServer0037 error code is generated.
To solve the issue, the API routes must be registered in another order by modifying the
SortOrder property of the respective API route. The SortOrder property specifies the
order in which the URL patterns are applied to the URL of an API request. API patterns with
the lowest SortOrder are used first.

Guidelines and conventions

In this chapter, you will find general policies and conventions, which you must take into
account when you create an API.

Handling API Server requests

In this section, you will find information about handling requests that are sent to the
API Server.

Authentication

When a request is sent to the API Server, there is a test to ascertain the success of the
primary and, possibly, secondary login in the session for the current project (see
Authentication on page 19).

NOTE: This test is not done if the API method used by the request is marked as
AllowUnauthenticated.

The imx-session-<API project name> cookie is evaluated to allocate the current

session.
If a cookie is passed that cannot be associated with an active session in the current
process, the security token in the cookie is used to set up a new session (see Session status
and security tokens on page 23).
If there is no primary login, the API Server tries to establish a database connection through
one of the enabled single sign-on authentication modules.

One Identity Manager 10.0 API Development Guide

8
Basic principles of API development
If login cannot be carried out, the process is canceled and the HTTP error code 500 is
passed to the client (see Response codes on page 18).

Authorizing method access

The API Server checks whether the currently logged in user is authorized to run the
method. If the user does not have the required permissions, the process is canceled and
the HTTP error code 500 is passed to the client (see Response codes on page 18).

Validating the request

The API Server calls the validators stored with the API method one by one. If one fails, the
process is canceled and the HTTP error code 400 is passed to the client (see Response
codes on page 18).

Processing requests (for entity methods)

l GET (loads an entity)
l Determines the WHERE clause with internal and external filters
l Loads data from the database
l Augments an entity with calculated columns
l An entity in delayed-logic mode can be changed with a POST request or deleted with
a DELETE request. An entity in this mode is stateless and does not take up any
resources on the server after it has been processed.
Supported HTTP methods:
l GET (reads an entity)
l POST (changes an entity)
l DELETE (deletes an entity)
l An interactive entity must be created once with a PUT request and after that they
obtain their own ID. Use the ID in subsequent requests (POST or DELETE).
Supported HTTP methods:
l GET (loads an entity)
l PUT (creates an interactive entity)
l POST (changes an interactive entity)
l DELETE (deletes an interactive entity)

API methods
You can define the following types of API methods.

One Identity Manager 10.0 API Development Guide

9
Basic principles of API development
 l Entity methods
l User-defined methods
l SQL methods
l WebSocket methods

NOTE: To restrict access to the API, you can assign permissions groups to API
methods.
For more information, see Authorization and authentication.

Entity methods
Entity methods work with small parts of the object model in order to read data from the
database or write data to the database. When you create an entity method, you only need
to enter the table and column name and, if required, a filter condition (WHERE clause).
Internal processing is handled by the API Server. The data schema for the input and output
also has a specific format.
For examples for the definition of entity methods, see the SDK under Sdk01_Basics\01-
[Link].

Advice
l Do not declare path parameters in the URL of entity methods that support operations
of type Update or Create.
l Hash values from columns that are declared as passwords cannot be queried via the
API and are always treated as "not visible" for security reasons.

Limiting results

NOTE: Entity-based methods normally work with a limit to avoid unintentionally

loading extremely large amounts of data.

The following query parameters help you to limit the amount of data that is returned by
obtaining multiple data sets from sequential responses:

Query Default Description

parameter value

PageSize 20 Specifies the maximum number of data sets that can be

contained in the response.
If you only determine the total number and do not want to

One Identity Manager 10.0 API Development Guide

10
Basic principles of API development
Query Default Description
parameter value

obtains single data sets, use the value -1.

StartIndex 0 Specifies as from which data sets the results are returned in
the response.
This parameter is null-based (the first element is addressed
with the value 0).

Example
The following request returns 50 identities and starts with the 101st identity:
[Link] name>/ApiServer/portal/person/all?PageSize=50&StartIndex=100

Sort order
Use the OrderBy query parameter to sort the results returned in an response. This
parameter allows you to sort the column names of the underlying database table.

Examples
The following request returns identities sorted by first name in ascending order:
[Link] name>/ApiServer/portal/person/all?OrderBy=FirstName
The following request returns identities sorted by first name in descending order
:[Link] name>/ApiServer/portal/person/all?OrderBy=FirstName%20DESC

Filtering
Use the filter query parameter to filter the results returned in an response. A filter like this
consists of a JSON formatted string that must contain the following:
l ColumnName: Name of the column used to filter
l CompareOp: The operator for comparing the contents of the selected column with
the expected value
The following comparison operators are permitted:
l Equal: The results only include data sets with column data that matches the
comparison value.
l NotEqual: The results only include data sets with column data that does NOT
match the comparison value.

One Identity Manager 10.0 API Development Guide

11
Basic principles of API development
 l LowerThan: The results only include data sets with column data less than the
comparison value.
l LowerOrEqual: The results only include data sets with column data less than
or equal to the comparison value.
l GreaterOrEqual: The results only include data sets with column data greater
than or equal to the comparison value.
l Like: Requires the use of a percent sign (%) as a placeholder. You can enter up
to two percent signs in this value. The results only include data sets with
column data that matches the comparison value pattern.
l NotLike: Requires the use of a percent sign (%) as a placeholder. You can
enter up to two percent signs in this value. The results only include data sets
with column data that does NOT match the comparison value pattern.
l BitsSet: The value is compared to the comparison value using the AND (&)
logical operator. The result must not be equal to 0.
l BitsNotSet: The value is compared to the comparison value using the AND (&)
logical operator. The result must be equal to 0.
l Value1: Comparison value for comparing the contents of the column
l Value 2: If this second comparison value is passed down, the value of CompareOp
is ignored and all the values that are greater or equal to Value1 and less or equal to
Value2 are determined.

Example
The following request returns all identities with the last name "User1":
[Link] name>/ApiServer/portal/person/all?filter=[{"ColumnName":
"LastName", "CompareOp": 0, "Value1": "Smith"}]

Grouping
You can use the group path parameter to group the results returned in a response. You can
use the by query parameter to specify which attribute to use for grouping. Furthermore,
you can use the withcount query parameter to specify (values: true or false) whether to
calculate the number of objects for each group. This may increase the runtime.

NOTE: The API method must support grouping (by using the EnableGrouping
parameter).

The result of the query contains a filter condition that you can pass to the URL
parameter as filter.

Example

One Identity Manager 10.0 API Development Guide

12
Basic principles of API development
The following requests determine the number of identities grouped by identity type:
[Link]
name>/ApiServer/portal/person/all/group?by=IdentityType&withcount=true
Response:

{
"TotalCount": 8,
"Groups": [
{
"Display": [
{
"Display": "(No value: Identity type)"
}
],
"Filters": [
{
"ColumnName": "IdentityType",
"Type": 0,
"CompareOp": 0
}
],
"Count": 0
},
{
"Display": [
{
"Display": "Machine identity"
}
],
"Filters": [
{
"ColumnName": "IdentityType",
"Type": 0,
"CompareOp": 0,
"Value1": "Machine"
}
],
"Count": 0
},
{
"Display": [
{
"Display": "Organizational identity"
}
],
"Filters": [
{
"ColumnName": "IdentityType",
"Type": 0,
"CompareOp": 0,
"Value1": "Organizational"
}

One Identity Manager 10.0 API Development Guide

13
Basic principles of API development
 ],
"Count": 3
},
{
"Display": [
{
"Display": "Personalized administrator identity"
}
],
"Filters": [
{
"ColumnName": "IdentityType",
"Type": 0,
"CompareOp": 0,
"Value1": "Admin"
}
],
"Count": 2
},
{
"Display": [
{
"Display": "Primary identity"
}
],
"Filters": [
{
"ColumnName": "IdentityType",
"Type": 0,
"CompareOp": 0,
"Value1": "Primary"
}
],
"Count": 3256
},
{
"Display": [
{
"Display": "Service identity"
}
],
"Filters": [
{
"ColumnName": "IdentityType",
"Type": 0,
"CompareOp": 0,
"Value1": "Service"
}
],
"Count": 0
},
{
"Display": [

One Identity Manager 10.0 API Development Guide

14
Basic principles of API development
 {
"Display": "Shared identity"
}
],
"Filters": [
{
"ColumnName": "IdentityType",
"Type": 0,
"CompareOp": 0,
"Value1": "Shared"
}
],
"Count": 0
},
{
"Display": [
{
"Display": "Sponsored identity"
}
],
"Filters": [
{
"ColumnName": "IdentityType",
"Type": 0,
"CompareOp": 0,
"Value1": "Sponsored"
}
],
"Count": 0
}
]
}

Hierarchical data structures

Some data model tables are defined as hierarchical structures (Department for example).
Data from such tables is loaded from a specific hierarchy level.
You can use the parentKey query parameter of the parent object to specify the
hierarchy level.

Example
The following request determines the service categories directly under the given
service category:
[Link] name>/ApiServer/portal/servicecategories?ParentKey=QER-
f33d9f6ec3e744a3ab69a474c10f6ff4

One Identity Manager 10.0 API Development Guide

15
Basic principles of API development
 The following request determines the service categories that do not have a parent
service category:
[Link] name>/ApiServer/portal/servicecategories?ParentKey=
The following request determines all service categories regardless of their hierarchy:
[Link] name>/ApiServer/portal/servicecategories

Additional query parameters

You can use the withProperties query parameter to specify whether additional
information from specific tables columns are returned in the response.

NOTE: To enable table columns for these queries, set the Show in wizards option in
the column properties of the relevant columns in the Designer.

TIP: You can delimit the names of multiple columns with commas.

Example
The following request determines the number of all identities and also returns their
preferred name and title:
[Link]
name>/ApiServer/portal/person/all?withProperties=PreferredName,Title
Response:

{
"TotalCount": 105950,
"TableName": "Person",
"Entities": [
{
"Display": "100, User (USER1)",
"LongDisplay": "100, User (USER1)",
"Keys": [
"bbf3f8e6-b719-4ec7-be35-cbd6383ef370"
],
"Columns": {
"DefaultEmailAddress": {
"Value": "USER1@[Link]",
"IsReadOnly": true
},
"IdentityType": {
"Value": "Primary",

One Identity Manager 10.0 API Development Guide

16
Basic principles of API development
 "IsReadOnly": true,
"DisplayValue": "Primary identity"
},
"PreferredName": {
"Value": "Johnny",
"IsReadOnly": true
},
"Title": {
"Value": "Dr.",
"IsReadOnly": true
},
"XObjectKey": {
"Value": "<Key><T>Person</T><P>bbf3f8e6-b719-4ec7-be35-
cbd6383ef370</P></Key>",
"IsReadOnly": true
}
}
}

Type-safe classes
Type-safe classes allow you to use the database model in a type-safe way. This gives you
the following advantages:
l Compiling scripts checks whether the classes used are correct. This allows you to
detect spelling mistakes in table and column names early on.
l The development environment can offer auto-completion.
l The column's data type is detected, which prevents type conversion errors.

To use type-safe classes

1. Edit the corresponding API plugin (see Editing API plugins on page 27) and proceed
as follows:
l Add a reference to the type-safe class library of the corresponding database
module ([Link] for example).
This makes the classes for this module available in the <module
name>.TypedWrappers namespace ([Link] for example).

User-defined methods
User-defined methods are methods for which you fully define the processing, input, and
output data in code. This type therefore offers the greatest flexibility.
For examples for the user-defined methods, see the SDK under Sdk01_Basics\03-
[Link].

One Identity Manager 10.0 API Development Guide

17
Basic principles of API development
SQL methods
SQL methods are methods that provide data from a predefined SQL query through the API.
Create the parameters of a request as SQL parameters.
For examples for the definition of SQL methods, see the SDK under Sdk01_Basics\02-
[Link].

WebSocket methods
Use WebSocket methods in situations where bidirectional, event controlled
communications is required. You define the processing as well as input and output data
within the WebSocket method.

NOTE: When the session ends or the server, all open WebSocket connections are
also closed.

For examples of WebSocket methods, see the SDK under Sdk01_Basics\[Link].

For more information about WebSocket implementation, see WebSocket Class.

Response codes
Responses that are sent from the REST API use the following codes. If requests fail, an
explanatory error message is displayed.

Response Description
codes

200 Request was successful.

204 Request was successful. Response has no content.

401 Access not authorized. The session must be authorized first.

403 Login failed. For example, this response is sent if an incorrect user name or
password is entered.

404 The given resource could not be found.

405 The HTTP method used is not allowed for this request.

500 A server error occurred. The error message is sent with the response. On
the ground of security, a detailed error message is not included in the
response. For more information, see the application log file on the server.

One Identity Manager 10.0 API Development Guide

18
Basic principles of API development
Related topics
l Response formats on page 19

Response formats
Most API methods return results in JSON format (application/json). Furthermore, there is
support for results in CSV and PDF format as long as the result of the respective API
method is declared as exportable (with the AllowExport flag). Basically, an API method
can return results in any format compatible with HTTP.

To obtain results in CSV format

l In the request, set Accept header to text/csv.

To obtain results in PDF format

l In the request, set Accept header to application/pdf.

NOTE: To obtain results in PDF format, the RPS module must be installed on
your system.

Related topics
l Response codes on page 18

Authentication
User authentication is carried out on the API Server for each API project.
Running an API method requires prior authentication on an API project. If the API method
is marked as AllowUnauthenticated, authentication is not required (you can find an
example in the SDK)
Authentication has two steps:

1. Required primary authentication: Default authentication through an

authentication module
2. Optional secondary authentication: Multi-factor authentication (using OneLogin)

For more information, see Configuring authentication.

Related topics
l Handling API Server requests on page 8

One Identity Manager 10.0 API Development Guide

19
Basic principles of API development
Configuring authentication
You can specify how users authenticate themselves on your API. You configure
authentication in the API project.

To configure authentication

1. Edit your API project.

2. Create the SessionAuthDbConfig class and populate the following properties:
a. Product: Specify the application with your preferred authentication module
(for example the WebDesigner or the Manager),
b. SsoAuthentifiers: Specify the single sign-on authentication modules to use.
c. ExcludedAuthentifiers: Specify the authentication modules not to use.

Authentication (primary)
You can use the imx/login/<API project name> API method for primary authentication
on the API project.
To do this, use the POST HTTP method to send a request containing the following:
{ "Module": "RoleBasedPerson", "User": "<user name>", "Password": "<password>" }

TIP: See the SDK for examples.

Security mechanisms

The API Server uses a security mechanism to prevent cross-site request forgery (XSRF)
attacks. This randomly generates a token (XSRF-TOKEN) and sends it to the client in a
cookie at login. The client must then transmit the value of this token in an HTTP header (X-
XSRF-TOKEN) in each request sent to the server. If this header is missing, the request is
terminated with error code 400.

NOTE: If an API request breaks off with an error and indicates an incorrect CSRF
protection cookie, check if your browser accepts the cookies sent by the browser.

TIP: You can change the name and path of the cookie and the name of the HTTP
header in the Administration Portal. To do this, use the Name of the cookie contain-
ing the CSRF protection token issued by the server (XsrfPro-
tectionCookieName) and Path for the CSRF protection cookie
(XsrfProtectionCookiePath) configuration keys.

One Identity Manager 10.0 API Development Guide

20
Basic principles of API development
 You can also disable CSRF protection in the Administration Portal (Globally disable
CSRF protection tokens (XsrfProtectionDisabled) configuration key). One
Identity does not recommend doing this.
For more information about editing configuration keys, see the Web Application
Configuration.

Logging out
You can use the imx/logout/<API project name> API method to log out of the
API project.
To do this, use the POST HTTP method to send a request without content.

Defining custom error messages

You can define your own error messages in API methods that are suited to your use case.
Use the [Link] property to do this.

Example

[Link]("person")
.FromTable("Person")
.EnableRead()
.With(m => [Link] = [Link]("This
identity could not be found."))

Date formats
Date values in requests to change or add objects must be specified in ISO 8601 format in
the client's local time zone.

Example
2016-03-19T13:09:08.123Z

Related topics
l Parameter formats on page 22

One Identity Manager 10.0 API Development Guide

21
Basic principles of API development
Avoiding deadlocks
API development includes a lot of asynchronous code with async/await constructs. To avoid
deadlocks, use the ConfigureAwait(false) method for every await keyword.
For more information, see here and here.

Querying API Server reachability

You can query the status of the API Server by creating your own API method that calls the
imx/ping URL. This method does not require prior authentication and returns the response
code 200 (OK) if the API server is running.

HTTP methods
HTTP requests can apply the following HTTP methods:
l GET: This method requests data from the application server.
l PUT: This method changes data on the application server.
l POST: This method creates data on the application server.
l DELETE: This method deletes data on the application server.

Parameter formats
HTTP requests use the following types of parameters:
l Path parameters
l Query parameters

Related topics
l Date formats on page 21

Path parameters
Path parameters extend the URL path. A forward slash is used as the delimiter.
If a request uses path parameters, they are given in URI format.

One Identity Manager 10.0 API Development Guide

22
Basic principles of API development
 Example
[Link] name>/ApiServer/imx/sessions/exampleparameter

Query parameters
Query parameter are appended to the URL with a question mark (?) or an ampersand (&).
The first query parameter must be prefixed by a question mark. In this case, you must use
the following format:
?parameter name=parameter value (for example, ?orderBy=LastName)
Subsequent query parameters must be prefixed by an ampersand. In this case, you must
use the following format:
&parameter name=parameter value (for example, ?sortOrder=ascending)

NOTE: Unknown query parameters are rejected by the server with error code 400.
This also affects query parameters with incorrect upper and lower case spelling.

Example
[Link] name>/AppServer/portal/person?orderBy=LastName

Session status and security tokens

The status a session is saved in a cookie. This cookie contains an encrypted security token
which is used to restore a login to the API Server if the API Server was restarted in the
mean time. The security token is cryptographically signed by the certificate selected on
installation.

NOTE: If the API Server's current user restarts the browser, the cookie and its session
information are reset.

Querying session status

You can use the imx/sessions/<API project name> API method to query the status of
the session. The response contains the following information:

One Identity Manager 10.0 API Development Guide

23
Basic principles of API development
 l Permitted authentication module and associated parameters of the respective
API project.
l Type of secondary login

Language
In web applications, every session has two language-specific properties: display language
and formatting language.

Display language

The display language specifies the language in which web application texts are shown.

Formatting language

The formatting language specifies the format of numerical data (e.g. numbers and dates).

Finding the language

To determine the display language, the following priority list is worked through for each API
request until the first step that returns a usable language is found:

1. person.UID_DialogCulture language of the logged in identity

2. Language of the client's language preference: First value of the Accept-Language
HTTP header
3. Fallback: [Link] of the web application thread
4. Fallback: en-US

The formatting language is determined as follows:

1. person.UID_DialogCultureFormat language of the logged in identity

2. Language of the client's language preference: First value of the Accept-Language
HTTP header
3. Fallback: [Link] of the web application thread
4. Fallback: display language

Remark

In the API Server, the CulturePlugIn is responsible for assigning the correct languages for
each request. The languages are set in the LanguageManager class and apply both to the
current thread and to asynchronously called tasks.
The data evaluation of the logged in identity is implemented by the
[Link] plugin.

One Identity Manager 10.0 API Development Guide

24
Basic principles of API development
 2

Examples and help – Software

Development Kit

To make it easier for you to start developing your API, One Identity provides a Software
Development Kit (SDK) with lots of commented code examples.
You will find the SDK in the GitHub Repository.

One Identity Manager 10.0 API Development Guide

25
Examples and help – Software Development Kit
 3

Implementing your own APIs

To implement your own APIs, you can create API plugins.

The API Server loads all DLLs matching the *.[Link] naming
scheme and deploys the API definitions contained in them.
To implement your own APIs, the following options are available:
l You can add an API to a One Identity API project (see Adding APIs to One Identity API
projects on page 29).
l You can create your own API project (Creating API projects on page 30).
l You can add an API to your own existing API projects (see Adding APIs to your own
API projects on page 31).

Managing API plugins

With the help of API plugins, you can implement and use your own customized APIs and
API projects.
Prerequisites:
l You use a version management system (for example, Git).
l You use an Integrated Development Environment (IDE).

Creating API plugins

To implement your own customized APIs and API projects, you can create API plugins.

To create an API plugin

1. Start your IDE (such as Visual Studio).

2. Create a new .NET 10 project with a name following this format: <project
name>.[Link].

One Identity Manager 10.0 API Development Guide

26
Implementing your own APIs
 3. Add references to the following DLL files from the One Identity Manager
installation directory:
l [Link]
l [Link]
l [Link]
4. Create the API code.
5. In the API code, add the following attribute in front of the namespace declaration:

[assembly: [Link]("CCC")]

6. Compile the DLL file in your IDE.

7. Copy the DLL file to the One Identity Manager install directory.
8. Import the DLL file into your Software Loader database using the
One Identity Manager and assign it to the Business API Server and Development
and Testing machine roles.
For more information, see Importing files with the Software Loader.
9. Restart the API Server and ensure that the <project
name>.[Link] file exists in the bin folder of the API Server
install directory.
10. Compile the appropriate TypeScript API client (see Compiling TypeScript API clients
on page 28).

Editing API plugins

You can edit existing API plugins.

To edit an existing API plugin

1. Start your IDE (such as Visual Studio).

2. Open an existing .NET 10 project.
3. Edit the API code.
4. Compile the DLL file in your IDE.
5. Copy the DLL file to the One Identity Manager install directory.
6. Import the DLL file into your One Identity Manager database using the
Software Loader.
For more information, see Importing files with the Software Loader.
7. Restart the API Server and ensure that the <project
name>.[Link] file exists in the bin folder of the API Server
install directory.

One Identity Manager 10.0 API Development Guide

27
Implementing your own APIs
 8. Compile the appropriate TypeScript API client (see Compiling TypeScript API clients
on page 28).

Compiling TypeScript API clients

After you create an API plugin, you need to compile a corresponding TypeScript API client.

To compile a TypeScript API client

1. Open a command line interface (for example, Windows Powershell).

2. In the command line program, go to the One Identity Manager installation directory.
3. Run the ImxClient's start-update command (see start-update on page 43).

Example

imxclient start-update

4. Run the ImxClient's compile-api command (see compile-api on page 33).

Example

imxclient compile-api /copyapi [Link] /packagename imx-

api-ccc

The dialog to select the database connection is opened.

5. In the dialog, perform one of the following actions:
l to use an existing connection to the One Identity Manager database, select it in
the Select a database connection drop-down.
- OR -
l to create a new connection to the One Identity Manager database, click Add
new connection and enter a new connection.
6. Select the authentication method and, under Authentication method, enter the
login data for the database.
7. Click Log in.
8. Import the imx-api-ccc npm package into your TypeScript application.

TIP: (Optional) If you want to use another name for the imx-api-ccc packet,
extend the [Link] by adding a line for the packet in the list.

One Identity Manager 10.0 API Development Guide

28
Implementing your own APIs
 This ensures that your package is not included in package locking and is always
updated from the local source.

9. Copy the [Link] to the bin\imx-modules subfolder of your IIS installation.

10. Import the TGZ file into your One Identity Manager database using the
Software Loader and assign it to the Business API Server machine role.
For more information, see Importing files with the Software Loader.
11. Restart the API Server and ensure that the [Link] file is in the bin\imx-
modules folder of your IIS installation.

Related topics
l compile-api on page 33

Adding APIs to One Identity API

projects
You can add your own APIs to One Identity API projects to add customized functionality to
One Identity web applications. To do this, create an API plugin, define the API in it and
assign the corresponding One Identity API project to the API plugin.

To add an API to a One Identity API project

1. Create or edit an API plugin (see Creating API plugins on page 26 or Editing API
plugins on page 27) and proceed as follows:
a. Create a new class in the API plugin project. This class represents the so-called
API provider.
b. Declare the class with the interface that belongs to the API project you want to
add your API to.
The following One Identity API projects can be added:

Table 1: Supplied API project

Web API Interface to implement

application project
name name

Web Portal portal IApiProviderFor<[Link]

rtalApiProject>

Administratio admin IApiProviderFor<[Link].

n Portal AdminApiProject>

One Identity Manager 10.0 API Development Guide

29
Implementing your own APIs
 Web API Interface to implement
application project
name name

Password Res- password- IApiProviderFor<[Link].

et Portal reset PasswordPortalApiProject>

c. Implement the Build method of the IApiProviderFor interface with the

desired API functionality.

Example

1 public class ExampleApi : IApiPro-

viderFor<[Link]>
2
3 {
4 public void Build(IApiBuilder builder)
5 {
6 [Link]([Link]("example")
7 .AllowUnauthenticated()
8 .HandleGet(qr => new DataObject { Message =
"Hello world!" }));
9 }
10 }

Creating API projects

Create your own API projects to add customized functionality to One Identity web
applications. To do this, copy the CustomApiProject sample API project (see Examples
and help – Software Development Kit on page 25), customize it as required, and assign it to
an API plugin.

To create your own API project

1. Copy the CustomApiProject sample API project.

2. Make changes to the copied API project as required.
3. Create an API plugin (see Creating API plugins on page 26) and proceed as follows:
l In the API plugin project, create a new class that implements the
IApiProviderFor<name of your API project> interface. This class
represents the so-called API provider.

One Identity Manager 10.0 API Development Guide

30
Implementing your own APIs
Adding APIs to your own API projects
You can add more APIs to your own API projects.

To add an API to your API project

1. Edit the API plugin (see Editing API plugins on page 27) associated with the API
project and proceed as follows:
l In the API plugin project, create a new class that implements the
IApiProviderFor<name of your API project> interface. This class
represents the so-called API provider.

One Identity Manager 10.0 API Development Guide

31
Implementing your own APIs
 4

ImxClient command line program

You can use the ImxClient command line tool to run different functions for managing the
API Server and files on the command line.

Starting the ImxClient command line

program
You can start the ImxClient command line tool at any time using any command line
interface.

To start the lmxClient command line program

1. Open a command line interface (for example, Windows Powershell).

2. In the command line program, go to the One Identity Manager installation directory.
3. Run the [Link] application.

ImxClient command overview

The following chapters contain a list of all ImxClient commands that you can run.

check-translations
Searches for captions (multilingual text) with missing translations in a particular folder and
its subfolders.

Parameters

Login parameter:

One Identity Manager 10.0 API Development Guide

32
ImxClient command line program
 l /conn <database connection>: Specifies the database you want to connect to.
l /dialog <authentication module>: Specifies the authentication module.

Required parameters:
l /path <path to folder>: Specifies the path to the folder you want to check.

Optional parameter:
l /conndialog <option>: Specifies whether a login window is displayed for the
database connection. The following options are possible:
l off: The login window is not shown. If the database is not connected, an
attempt is made to establish a connection.
l show: The login window is shown (even is a database is already connected) and
the new connection replaces the old one.
l fallback (default): The current database connection is used. If the database is
not connected, an attempt is made to establish a connection.
l /factory <target system>: Specifies the target system for the connection. Enter this
parameter if you want to establish a connection to the application server.
Example: [Link], [Link]

compile-api
Compiles the API. This performs the following steps:
l Verifies the API definition
l Compiles a TypeScript API client library
l Creates a DialogAEDS EP object in the database for each API endpoint

Parameters

Login parameter:
l /conn <database connection>: Specifies the database you want to connect to.
l /dialog <authentication module>: Specifies the authentication module.

Optional parameter:
l /factory <target system>: Specifies the target system for the connection. Enter this
parameter if you want to establish a connection to the application server.
Example: [Link], [Link]
l N: Prevents saving to the database.
l /modules <module1, module2>: Specifies which modules are included. If you do not
enter anything here, all modules are included. Enter the modules' names,
delimited by commas.

One Identity Manager 10.0 API Development Guide

33
ImxClient command line program
 l /clientmodules <module1,module2,...>: Specifies the modules for which API code is
generated. If you do not enter anything here, API code is generated every module.
Enter the packages' names, delimited by commas.
l /packagename <name>: Specifies the API client package name. The default value
is imx-api.
l /copyapi <folder path>: Specifies where to copy the [Link] to.
l /nowarn <error1,error2,...>: Specifies which errors are ignored during compilation.
Enter the codes for the warnings, separated by commas.
l /warnaserror <error1,error2,...>: Specifies which warnings are displayed as errors
during compilation. Enter the codes for the warnings, separated by commas.
l /endpointdef {filename}: Specifies that the API endpoint list is written to file instead
of creating DialogAEDS objects.

compile-app
Runs HTML5 package compilation.
This command performs the following steps:

1. Runs the npm install command in the application folder.

2. Runs the npm run build command in the package folder.
3. Creates the output in subdirectory dist
.The output is stored as a zip file in the database.

Parameters

Login parameter:
l /conn <database connection>: Specifies the database you want to connect to.
l /dialog <authentication module>: Specifies the authentication module.

Optional parameter:
l /conndialog <option>: Specifies whether a login window is displayed for the
database connection. The following options are possible:
l off: The login window is not shown. If the database is not connected, an
attempt is made to establish a connection.
l show: The login window is shown (even is a database is already connected) and
the new connection replaces the old one.
l fallback (default): The current database connection is used. If the database is
not connected, an attempt is made to establish a connection.
l /factory <target system>: Specifies the target system for the connection. Enter this
parameter if you want to establish a connection to the application server.
Example: [Link], [Link]

One Identity Manager 10.0 API Development Guide

34
ImxClient command line program
 l /workspace <path to working directory>: Specifies the working directory. This
folder contains the application to be compiled. This folder normally contains the
[Link] file of the application. If you do not enter anything here, the current
directory is used.
l /app <application project name>: Specifies which application project to compile. If
you do not specify anything here, all application projects are compiled.
l -D: Runs debug compilation.
l -S: Skips running the npm install command in the application folder.
l -P: Prevents libraries being build in the application folder.
l /copyto <file path>: Saves the result of the compilation as ZIP files in a folder.
l /exclude <module name>: Omits packages of a module at compile time (for
example, AOB).

connect
Establishes a database connection.
If a connection to a database has already been established, this is closed and a new
connection is then established.

Parameters

Login parameter:
l /conn <database connection>: Specifies the database you want to connect to.
l /dialog <authentication module>: Specifies the authentication module.

Optional parameter:
l /conndialog <option>: Specifies whether a login window is displayed for the
database connection. The following options are possible:
l off: The login window is not shown. If the database is not connected, an
attempt is made to establish a connection.
l show: The login window is shown (even is a database is already connected) and
the new connection replaces the old one.
l fallback (default): The current database connection is used. If the database is
not connected, an attempt is made to establish a connection.
l /factory <target system>: Specifies the target system for the connection. Enter this
parameter if you want to establish a connection to the application server.
Example: [Link], [Link]

One Identity Manager 10.0 API Development Guide

35
ImxClient command line program
edit-config
Configures a trusted source key for an application.

Parameter

Login parameter:
l /conn <database connection>: Specifies the database you want to connect to.
l /dialog <authentication module>: Specifies the authentication module.

Required parameters:
l /path <path to folder>: Specifies which configuration file to load (for example, the
[Link] file of a web application). The BaseURL setting of this configuration file is
used to determine the application to create the trusted source key for.

Optional parameter:
l /conndialog <option>: Specifies whether a login window is displayed for the
database connection. The following options are possible:
l off: The login window is not shown. If the database is not connected, an
attempt is made to establish a connection.
l show: The login window is shown (even is a database is already connected) and
the new connection replaces the old one.
l fallback (default): The current database connection is used. If the database is
not connected, an attempt is made to establish a connection.
l -T: Configures a random generated trusted source key for the application.
l /trustedsourcekey <trusted source key>: Configures the given trusted source key
for the application.

fetch-files
Loads a specific machine role from the database and saves it in a local folder.

Parameters

Login parameter:
l /conn <database connection>: Specifies the database you want to connect to.
l /dialog <authentication module>: Specifies the authentication module.

Required parameters:
l /targets <target1;target2;...>: Specifies which are your preferred machine roles.

Optional parameter:

One Identity Manager 10.0 API Development Guide

36
ImxClient command line program
 l /conndialog <option>: Specifies whether a login window is displayed for the
database connection. The following options are possible:
l off: The login window is not shown. If the database is not connected, an
attempt is made to establish a connection.
l show: The login window is shown (even is a database is already connected) and
the new connection replaces the old one.
l fallback (default): The current database connection is used. If the database is
not connected, an attempt is made to establish a connection.
l /factory <target system>: Specifies the target system for the connection. Enter this
parameter if you want to establish a connection to the application server.
Example: [Link], [Link]
l /workspace <working directory path>: Specifies the working directory to put the
files. If you do not enter anything here, the current directory is used.

get-filestate
Compares the local file structure with the file structure in the database.
Using the QBM | ImxClient | get-filestate | NewFilesExcludePatterns configuration
parameter, you can define which files are excluded from the synchronization. This prevents
excessive load during synchronization. The node_modules and imx-modules folders are
excluded from the synchronization by default.
You can adjust the configuration parameters in the Designer. Use the following formats
when defining the rules:
[Link]
Use the | character to delimit multiple entries.

NOTE: This configuration parameter is generally only used to exclude new files from
the synchronization. Files that already exist in the database are not taken into account.

Parameters

Login parameter:
l /conn <database connection>: Specifies the database you want to connect to.
l /dialog <authentication module>: Specifies the authentication module.

Required parameters:
l /targets <target1;target2;...>: Specifies which are your preferred machine roles.

Optional parameter:
l /conndialog <option>: Specifies whether a login window is displayed for the
database connection. The following options are possible:

One Identity Manager 10.0 API Development Guide

37
ImxClient command line program
 l off: The login window is not shown. If the database is not connected, an
attempt is made to establish a connection.
l show: The login window is shown (even is a database is already connected) and
the new connection replaces the old one.
l fallback (default): The current database connection is used. If the database is
not connected, an attempt is made to establish a connection.
l /factory <target system>: Specifies the target system for the connection. Enter this
parameter if you want to establish a connection to the application server.
Example: [Link], [Link]
l /workspace <directory path>: Specifies the working directory where the files you
want to match are located. If you do not enter anything here, the current
directory is used.

help
Displays a list of available commands.

Parameters

To view help for a specific command, add the command as a parameter.

Example: help fetch-files

inject-package
Installs packages from a tgz file into the node_modules directory of the working directory.
This is intended to be used only with local, dependency-free packages that do not require a
full NPM installation.

Parameter

Required parameters:
l /inject <package1>,<package2>,...: Specifies which packages to install. Enter the
packages' names, separated by commas.

Optional parameter:
l /workspace <working directory path>: Specifies the working directory where the
packages will be installed in the node_modules subdirectory. If you do not enter
anything here, the current directory is used.

One Identity Manager 10.0 API Development Guide

38
ImxClient command line program
install-apiserver
Installs an API Server on the local Internet Information Services (IIS).

Parameters

Login parameter:
l /conn <database connection>: Specifies the database you want to connect to.
l /dialog <authentication module>: Specifies the authentication module.

Required parameters:
l /app <application name>: Specifies which name is used for the application (for
example, in the browser's title bar).
l /sessioncert <certificate thumbprint>: Specifies which (installed) certificate is
used for creating and verifying session tokens.

TIP: For example, to obtain a certificate thumbprint, you can use the Manage
computer certificates Windows function and find the thumbprint through the
certificate's detailed information.

Optional parameter:
l /conndialog <option>: Specifies whether a login window is displayed for the
database connection. The following options are possible:
l off: The login window is not shown. If the database is not connected, an
attempt is made to establish a connection.
l show: The login window is shown (even is a database is already connected) and
the new connection replaces the old one.
l fallback (default): The current database connection is used. If the database is
not connected, an attempt is made to establish a connection.
l -u: Allows insecure HTTP connections to the API Server website. By default, the
API Server website can only be opened over an encrypted connection.
l /site <site name>: Specifies the website on the IIS under which the web application
will be installed. If you do not enter anything, the website is found automatically
(normally Default website).
l /searchservice <URL>: Specifies the application server's URL that the search service
you want to use is hosted on.

NOTE: If you would like to use the full-text search, then you must specify an
application server. You can enter the application server in the configuration file at
a later date.

l /roles <role name1|role name2|...>: Specifies which machine roles to install. Enter
the names of the machine roles separated by pipes (|). If you do not enter anything

One Identity Manager 10.0 API Development Guide

39
ImxClient command line program
 here, the default Server\Web\BusinessApiServer value is used. You can select the
follow values:
l Server\Web\BusinessApiServer: Contains the basic components for setting up
an API Server.
l Server\Web\BusinessApiServer\AdministrationPortal: Contains the
Administration Portal.
l Server\Web\BusinessApiServer\ApiMonitoring: Contains the
Operations Support Web Portal.
l Server\Web\BusinessApiServer\ApiServerManager: Contains the Manager web
application.
l Server\Web\BusinessApiServer\AppInsights: Contains the plugin for
integration with Microsoft Application Insights.
l Server\Web\BusinessApiServer\EndUserApps: Contains the Web Portal and the
Password Reset Portal.
l Server\Web\BusinessApiServer\SCIMProvider: Contains the SCIM Plugin for the
API Server.
For more information, see Overview of machine roles.

push-files
Saves files that you have changed locally back to the database.

Parameters

Login parameter:
l /conn <database connection>: Specifies the database you want to connect to.
l /dialog <authentication module>: Specifies the authentication module.

Required parameters:
l /targets <target1;target2;...>: Specifies which are your preferred machine roles.

Optional parameter:
l /conndialog <option>: Specifies whether a login window is displayed for the
database connection. The following options are possible:
l off: The login window is not shown. If the database is not connected, an
attempt is made to establish a connection.
l show: The login window is shown (even is a database is already connected) and
the new connection replaces the old one.
l fallback (default): The current database connection is used. If the database is
not connected, an attempt is made to establish a connection.

One Identity Manager 10.0 API Development Guide

40
ImxClient command line program
 l /factory <target system>: Specifies the target system for the connection. Enter this
parameter if you want to establish a connection to the application server.
Example: [Link], [Link]
l /workspace <folder path>: Specifies the working directory where the files are
located that have been modified and are now to be stored in the database. If you do
not enter anything here, the current directory is used.
l /tag <uid>: Specifies the change label to use to book the changes.
For more information, see Working with change labels.
l /add <file1;file2;...>: Specifies which new database files are added. Use
relative paths.
l /del <file1;file2;...>: Specifies which database files are deleted. Use
relative paths.
l -C: Prevents the saving of changed files and saves only new files, and deletes files
from the database.

repl
Starts the ImxClient command line tool in REPL mode.
In this mode, the following actions are performed in an infinite loop:
l Read commands from stdin
l Forward commands to the relevant plugin
l Output the results of processing to stdout

run-apiserver
Starts or stops a local self-hosted API Server.
This command requires a database connection.

Parameters

Login parameter:
l /conn <database connection>: Specifies the database you want to connect to.
l /dialog <authentication module>: Specifies the authentication module.

Optional parameter:
l /conndialog <option>: Specifies whether a login window is displayed for the
database connection. The following options are possible:

One Identity Manager 10.0 API Development Guide

41
ImxClient command line program
 l off: The login window is not shown. If the database is not connected, an
attempt is made to establish a connection.
l show: The login window is shown (even is a database is already connected) and
the new connection replaces the old one.
l fallback (default): The current database connection is used. If the database is
not connected, an attempt is made to establish a connection.
l /factory <target system>: Specifies the target system for the connection. Enter this
parameter if you want to establish a connection to the application server.
Example: [Link], [Link]
l -S: Stops the API Server.
l /baseaddress <base URL with port>: Specifies the base URL and port of the web
application where the API Server accepts connections.

Example

/baseaddress [Link]

l /baseurl <root URL>: Specifies the web application's URL.

Example

/baseaddress [Link]

l /plugin <file name 1, file name 2>: Loads additional plugins from the given files.
l /htmldir <directory>: Specifies the directory to use to load additional web
application files and plugin. This setting is intended for development scenarios.

Example

/htmldir C:example\imxweb\cpl

The cpl plugin is loaded from the C:example\imxweb\cpl folder instead of the
default source.

l -T: Queries the status of the current API Server.

l -B: Locks the console.

One Identity Manager 10.0 API Development Guide

42
ImxClient command line program
start-update
Checks if software updates are available. If software updates are found, the software
update starts.

Parameter

Login parameter:
l /conn <database connection>: Specifies the database you want to connect to.

Optional parameter:
l /target <update directory path>: Specifies the installation directory of the software
to update. If you do not enter anything here, the current directory is used.
l -C: Only checks if software updates are available. The software update does
not start.
l -G: Hides the software update user interface.

workspace-info
Queries the state of the Angular working directory (existing applications and last API
client update).

Parameters

Optional parameter:
l /workspace: Specifies which working directory to query. If you do not enter anything
here, the current directory is used.

One Identity Manager 10.0 API Development Guide

43
ImxClient command line program
 About us

About us

One Identity solutions eliminate the complexities and time-consuming processes often
required to govern identities, manage privileged accounts and control access. Our solutions
enhance business agility while addressing your IAM challenges with on-premises, cloud and
hybrid environments.

Contacting us
For sales and other inquiries, such as licensing, support, and renewals, visit
[Link]

Technical support resources

Technical support is available to One Identity customers with a valid maintenance contract
and customers who have trial versions. You can access the Support Portal at
[Link]
The Support Portal provides self-help tools you can use to solve problems quickly and
independently, 24 hours a day, 365 days a year. The Support Portal enables you to:
l Submit and manage a Service Request
l View Knowledge Base articles
l Sign up for product notifications
l Download software and technical documentation
l View how-to videos at [Link]/OneIdentity
l Engage in community discussions
l Chat with support engineers online
l View services to assist you with your product

One Identity Manager 10.0 API Development Guide

44
About us
 Index
Index

A E
API development entity methods
basics 6 general 10
API files 9 examples 25
async 22
authentication 19
F
primary 19-20
filtering 10
secondary 19
format
await 22
date 21
parameter 22
B response 19
basics 6

G
C grouping 10
CLI 32
code 18
H
command line 32
help 25
commandos 32
HTTP method 22
ConfigureAwait 22
conventions 8
CSV 19 I
custom methods 17 ImxClient 32
commandos 32

D check-translations 32
compile api 33
data structure
compile app 34
hierarchical 10
connect 35
date format 21
edit-config 36
deadlock 22
fetch-files 36

One Identity Manager 10.0 API Development Guide

45
Index
 get-filestate 37 validation 8
help 38 query parameter 23
inject-package 38
install-apiserver 39 R
push-files 40
response 18
repl 41
response code 18
run-apiserver 41
response format 19
start-update 43
run
workspace-info 43
command line program 32
ImxClient command line program
start 32
S
SDK 25
L
security token 23
limit 10
session
log out 21
status 23
login 20
session status
inquiry 23
M software development kit 25
method type 22 sort by 10
SQL files 18

P StartIndex 10

PageSize 10
parameter format 22 T
query parameter 23 token 23
URL parameter 22
PDF 19 U
policies 8
URL parameter 22

Q
W
query
WebSocket methods 18
authentication 8
authorization 8
processing 8

One Identity Manager 10.0 API Development Guide

46
Index