One Identity Manager 8.1.

API Designer User and Development

Guide
Copyright 2020 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 Web site ([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. 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 Designer User and Development Guide

Updated - March 2020
Version - 8.1.2
Contents

API Designer 7

Basic principles of API development 8

Examples and help – Software Development Kit 9

Quick start – Creating an API 10

Working with the API Designer 11

Starting the API Designer 11
Project types 12
Changing the project type 12
Solution projects 13
Importing solution project changes into a database 14
User interface 15
Menu bar 16
Toolbar 19
Status bar 20
Navigation 21
Opening the navigation 22
Start page 23
Opening the start page 23
Global settings 23
Changing global settings 26
Switching languages 26
Database objects 27
Object properties 27
Displaying object properties 28
Managing objects in a project (solution) 29
Opening the solution 30
Editing database objects (definition tree view) 30
Opening the definition tree view 31
Context menu in the definition tree window 32
Extensions 34

One Identity Manager 8.1.2 API Designer User and Development Guide 3
 Viewing and saving generated code belonging to a node 34
Node editor view 35
Labeling changes 37
Using change labels 38
Creating a change label 38
Change management 39
Deleting change labels 40
Find and replace 40
Running a search 43
Multilingual captions 44
Creating multilingual captions 45
Searching for a multilingual caption 45
Editing a multilingual caption 46
Deleting a multilingual caption 47
Managing database queries 48
Displaying database queries 49
Creating a database query 50
Editing a database query 50
Testing a database query 51
Deleting a database query 52
Managing tabs 52
Managing layouts 53
Displaying the change history (command list) 54
Opening the command list 54
Bookmarks 55
Editing bookmarks 55
Setting bookmarks 56
Deleting bookmarks 57
Compiling an API 57
Testing a compilation 58
Starting a compilation 59
Managing compilation errors and warnings (task window) 60
Opening the task window 61
Resolving errors and warnings 61
Opening the compiling log 61

One Identity Manager 8.1.2 API Designer User and Development Guide 4
Managing versions (compilation branches) 62
Selecting and using compilation branches 62
Creating compilation branches 63
Editing compilation branches 63
Deleting compilation branches 64
Testing an API 64
Linking C# projects to the API Designer 65

API projects 68
Creating API projects 68
Editing API projects 69
Deleting API projects 70
Configuring authentication 71
Configuring the compilation 74
Assigning API files to an API project 74
Importing API projects 75

API files 76
Creating API files 77
Editing API files 77
Deleting API files 78
Assigning API files to an API project 78
Importing API files 79

API Server 81

ImxClient command line program 82

Starting the ImxClient command line program 82
ImxClient command overview 82
help 83
compile-app 83
repl 84
branch 84
connect 85
compile-api 85
fetch-files 87
push-files 87
get-apistate 88

One Identity Manager 8.1.2 API Designer User and Development Guide 5
 get-filestate 88
setup-web 89
run-apiserver 90
check-translations 91

About us 92
Contacting us 92
Technical support resources 92

Index 93

One Identity Manager 8.1.2 API Designer User and Development Guide 6
 1

API Designer

The API Designer allows you to create, record, compile, and publish a REST API
(Representational State Transfer Application Programming Interface) in the quickest way
possible. This API is based on the OpenAPI Specification and the One Identity Manager
database model.
The main benefits of API Designer include:

l Offers easy and fast operation.

l The finished API "understands" the One Identity Manager database model.
l Modifications to the API are transparent.
l Supports the principles of good API design.
l OpenAPI support: APIs that you create using the API Designer are based on
the OpenAPI specification standard. This allows you to make use of other
tools, including:
l Swagger: Use Swagger to create code, documentation, and test cases.
l Postman: Use Postman to test the various methods of your API.

One Identity Manager 8.1.2 API Designer User and Development Guide
7
API Designer
 2

Basic principles of API development

The main components of an API created using the API Designer are files and projects.
Basic information on API files:

l You can use API files to send data to the application or request data from the
application.
l An API file can belong to more than one project.

The basics of API projects:

l API projects combine multiple API files into logical sections. The API project includes
the configuration.

Related topics

l Quick start – Creating an API on page 10

One Identity Manager 8.1.2 API Designer User and Development Guide
8
Basic principles of API development
 3

Examples and help – Software

Development Kit

To make it easier for you to start developing your API with the API Designer, One Identity
provides a Software Development Kit (SDK) with lots of commented code example.
The SDK can be found on the installation medium in the directory
QBM\dvd\AddOn\ApiSamples.

One Identity Manager 8.1.2 API Designer User and Development Guide
9
Examples and help – Software Development Kit
 4

Quick start – Creating an API

The following provides a rough list of the steps you must take to create an API in the
API Designer:

1. Start the API Designer.

2. Create API files (in which you can define an API method, for example).
3. Create an API project.
4. Configure the authentication for the API project (Single Sign-On, for example).
5. Assign the created API files to the API project.
6. Test the API.
7. Compile the API.
8. Save the changes to the database.

Related topics

l Starting the API Designer on page 11

l Creating API files on page 77
l Creating API projects on page 68
l Configuring authentication on page 71
l Assigning API files to an API project on page 78
l Testing an API on page 64
l Compiling an API on page 57
l Importing solution project changes into a database on page 14

One Identity Manager 8.1.2 API Designer User and Development Guide
10
Quick start – Creating an API
 5

Working with the API Designer

This section provides you with general information on working with the API Designer.
For example, you will learn:

l How the API Designer interface is structured

l How to edit your projects - locally or within the database itself
l How to edit database objects
l To compile an API

and much more.

Starting the API Designer

Before you start developing your API, you must start the API Designer.

To start the API Designer

1. Go to the installation path for API Designer.

2. Run the [Link] application.
The API Designer opens.
3. Perform one of the following tasks:
l To use an existing connection to the One Identity Manager database, select it in
the Select a database connection menu.
l To create a new connection to the One Identity Manager database, click Add
new connection and enter a new connection.
4. Select the authentication method and enter the login data for the database under
Authentication method.
5. Click Connect.
6. In the Select project save type dialog, perform one of the following tasks:

One Identity Manager 8.1.2 API Designer User and Development Guide
11
Working with the API Designer
 l Click Database project to save the project in the database.
l Click Solution project to save the project within a solution.
TIP: For more information, see Project types on page 12.
7. (Optional) To save the selected storage type for future projects, select the Use
selected project as default option.
8. Click OK.
The API Designer opens and displays the start page.

Related topics

l Start page on page 23

l Project types on page 12

Project types
The API Designer distinguishes between two different project types for saving your
changes.

l Database project: The project will be stored in the database. Your saved changes are
visible to others.
l Solution project: API Designer allows file-based editing of custom objects locally on
your own computer. For more information, see Solution projects on page 13.

Related topics

l Changing the project type on page 12

l Solution projects on page 13
l Importing solution project changes into a database on page 14
l Menu bar on page 16

Changing the project type

You can save your project as a database project or as a solution project. For more
information, see Project types on page 12.

To save the project as a database project

1. On the menu bar, click Edit | Set project type.

2. In the Select the project type dialog, click Database project.
3. (Optional) To save the selection and use it the next time you start the API Designer,

One Identity Manager 8.1.2 API Designer User and Development Guide
12
Working with the API Designer
 enable the option Use selected project as default.
TIP: To undo this setting:
1. Click Connection | Settings on the menu bar.
2. Expand the Editor pane in the Global settings dialog.
3. In the Editor pane, select the Ask for project type at each start option.
The next time the program is started, the Select the project type dialog
is displayed.
4. Click OK.

To save the project as a solution project

1. On the menu bar, click Edit | Set project type.

2. In the Select the project type dialog, click Solution project.
3. Perform one of the following actions:
l Click Create solution and use the wizard to create a new solution.
l Click Load solution and enter the path to an existing solution.
l Click the solution most recently used.
4. (Optional) To save the selection and use it the next time you start the API Designer,
enable the option Use selected project as default.
TIP: To undo this setting:
1. Click Connection | Settings on the menu bar.
2. Expand the Editor pane in the Global settings dialog.
3. In the Editor pane, select the Ask for project type at each start option.
The next time the program is started, the Select the project type dialog
is displayed.
5. Click OK.

Related topics

l Project types on page 12

l Menu bar on page 16

Solution projects
API Designer allows for custom objects to be edited locally in a file-based format on your
own computer. To do this you will need to export any custom objects stored within the
database to the API Designer. In other words, you must use the "solution project" project
type (see Changing the project type on page 12).
To import the changes made to the solution project back into the database, follow the
instructions in Importing solution project changes into a database on page 14.

One Identity Manager 8.1.2 API Designer User and Development Guide
13
Working with the API Designer
After exporting these objects from the database, you can edit and remove them on your
computer, or supplement them with additional objects. Local object editing is no different
than editing within the database project.
During export, any objects contained in the selected module are copied to the hard drive:

l API projects
l API files

Related topics

l Changing the project type on page 12

l Importing solution project changes into a database on page 14
l Menu bar on page 16

Importing solution project changes into a

database
Changes that have been executed within a solution project must be transferred into the One
Identity Manager database.

To import object into the One Identity Manager database

1. Click Edit | Import objects into database on the menu bar.

2. In the Import objects into database dialog, enable the option Remove deleted
objects from database. Objects that you have deleted from your solution project
are now also deleted from the database.
3. Go to Solution objects to select the objects that you want to change and export into
the database.
TIP: To select or deselect listed objects quickly, enable the Select all/deselect
all option.
4. Click Continue.
5. Click Finished.

Related topics

l Solution projects on page 13

l Project types on page 12

One Identity Manager 8.1.2 API Designer User and Development Guide
14
Working with the API Designer
User interface
This section will give you a rough overview of the graphical user interface of the
API Designer.
Use the mouse and keyboard to interact with the API Designer‘s graphical user interface.
Use a screen resolution of at least 1280 x 1024 pixels and a minimum color depth of 16 bits
for optimum display.
TIP: The API Designer view can be customized at any time to suit your needs by moving,
closing, or hiding items.

Main user interface components

l Top – Title bar

The title bar shows the program icon, program name, and connected database
(including the current user).
l Top – Menu bar
You can use the menus on the menu bar to access submenus and to access and
execute many functions in API Designer quickly. For more information, see Menu bar
on page 16.
l Top – Toolbar
The toolbar contains different icons that you can click to access other functions. For
more information, see Toolbar on page 19.
l Left – Navigation
Use the navigation to manage (create, open, delete) API configurations, API files,
and API projects. You can also access the most recently edited file here. For more
information, see Navigation on page 21.
l Center – Work pane
The center pane is where other work panes for editing are shown, such as the
Definition tree view. When you open objects, they are shown in the work pane in
separate Tabs.
l Bottom – Status bar
The status bar shows information such as database activity, project information,
the connected database, and the current user. For more information, see Status
bar on page 20.

Start page

The start page is displayed when the API Designer starts up.
On the start page, you can:

l Use compilation branches to store different versions of your API in the database.
l Test your API locally

One Identity Manager 8.1.2 API Designer User and Development Guide
15
Working with the API Designer
 l Compile the API and then write it to the database
l Use the API Designer to connect and edit C# projects

For more information, see Start page on page 23.

Detailed information about this topic

l Menu bar on page 16

l Toolbar on page 19
l Status bar on page 20
l Navigation on page 21
l Start page on page 23

Menu bar
You can use the menus on the menu bar to access submenus and to access and execute
many functions in API Designer quickly. The following table provides you with information
about each menu.

Table 1: Menus and menu items on the menu bar.

Menu Menu item Description

Connection

Settings Opens the Global settings dialog. You can configure the basic
settings for API Designer here.
For more information, see Global settings on page 23.

Exit Closes the program.

Edit

Set project Opens the Select the project type dialog. Select whether the
type project should be saved as a database or solution project here.
For more information, see Project types on page 12 and
Changing the project type on page 12.

Import objects Opens the Import objects into database dialog.

into database
From here you can import new and modified objects from your
solution project into your One Identity Manager database.
For more information, see Importing solution project changes
into a database on page 14.

Change From here you can change the solution project that is to be used
standard here.

One Identity Manager 8.1.2 API Designer User and Development Guide
16
Working with the API Designer
Menu Menu item Description

project file

Find and Opens the Find and replace dialog. You can search through
replace documents using certain terms or strings and replace where
necessary here.
For more information, see Find and replace on page 40.

Find next Performs the search with the search parameters specified in the
Find and replace dialog.
The search continues without reopening the dialog.

Captions Opens the Multilingual captions dialog. You can create and
edit multilingual captions here.
For more information, see Multilingual captions on page 44.

Import object You can use this menu item to import API projects and API files
into the API Designer.
For more information, see Importing API projects on page 75
and Importing API files on page 79.

Edit database Opens the Edit database queries dialog. You can add, change,
queries or delete database queries here.
For more information, see Managing database queries on page
48.

View

Tabs Opens the Tabs dialog. You can manage open tabs here. For
more information, see Managing tabs on page 52.

Restore Restores the default layout. For more information, see Managing
standard layouts on page 53.
layout

Restore Restores the default layout and the default window size. For
standard more information, see Managing layouts on page 53.
layout
(including
size)

Restore saved Restores the layout that you saved earlier (see Save layout on
layout the menu). For more information, see Managing layouts on page
53.

Save layout After you have customized the layout of the API Designer to suit
your needs, you can save it and restore it at any time. For more
information, see Managing layouts on page 53.

Start page Opens the start page.

One Identity Manager 8.1.2 API Designer User and Development Guide
17
Working with the API Designer
Menu Menu item Description

For more information, see Start page on page 23.

Solution Opens the Solution window. The solution can be used to display
and manage any objects in the API Designer that can be opened
from the navigation menu.
For more information, see Managing objects in a project
(solution) on page 29.

Node editor Opens the Node editor view. You can edit a node’s properties
here.
For more information, see Node editor view on page 35.

Tasks Opens the Tasks view. Compilation errors and warnings can be
viewed here.
For more information, see Managing compilation errors and
warnings (task window) on page 60.

Command List Opens the Command list window. You can view the change
history of the selected database object here and undo any
changes where necessary.
For more information, see Displaying the change history
(command list) on page 54.

Compilation Opens the Compiling window. You can view the compilation log
here.
For more information, see Opening the compiling log on page 61.

Bookmarks Opens the Bookmarks window. Bookmarks can be managed

here.
For more information, see Bookmarks on page 55.

Navigation Opens the navigation view. This can be used to manage (create,
open, delete) API files, and API projects. You can also access the
most recently edited file here.
For more information, see Navigation on page 21.

Help

Community Opens the One Identity forum.

Support portal Opens the support portal website.

Training Opens the training website.

Online Opens One Identity‘s documentation website.

documentation

Info Opens a dialog. Detailed information on the API Designer is

One Identity Manager 8.1.2 API Designer User and Development Guide
18
Working with the API Designer
Menu Menu item Description

available here (system information, version number,

information about the software producer, installed modules
etc.).

Related topics

l User interface on page 15

l Global settings on page 23
l Changing the project type on page 12
l Find and replace
l Multilingual captions
l Importing API projects
l Managing database queries on page 48
l Managing tabs on page 52
l Managing layouts on page 53
l Start page on page 23
l Managing objects in a project (solution) on page 29
l Node editor view on page 35
l Managing compilation errors and warnings (task window) on page 60
l Displaying the change history (command list) on page 54
l Bookmarks on page 55
l Navigation on page 21
l Opening the compiling log on page 61

Toolbar
The toolbar contains different icons that you can click to access other functions.

Table 2: Toolbar functions

Icon Description

Change In the list, select the label under which changes made to the One Identity
Label: Manager database are to be saved. Use the label to make it easier to
identify and assign changes to the database. For more information, see
Labeling changes on page 37.

Managing Opens the Change label dialog. You can select, add, change, or delete
change labels change labels here. For more information, see Labeling changes on page

One Identity Manager 8.1.2 API Designer User and Development Guide
19
Working with the API Designer
Icon Description

37.

Use the Specify that the current change label see Change label) is to be used as
current the default change label. This change label will automatically be selected
change label upon API Designer startup. This setting is bound to the client and does not
as default affect other users of the One Identity Manager database. For more
information, see Using change labels on page 38.

Captions Opens the Multilingual captions dialog. Here you can create and edit
multilingual captions. For more information, see Multilingual captions on
page 44.

Testing a Tests the compilation for either the Debug or Release version. For more
compilation information, see Testing a compilation on page 58.

Save Saves changes to the object currently being edited. If you want to save
changes to other database objects, select the corresponding tab in the
definition tree view and click the button.

Save all Saves changes to all objects currently being edited.

Navigates backwards and forwards within the history of the selected

Previous/next objects. This displays the selected database object in the definition tree
node view.
If an object or node has been deleted, the next object is shown. If an
object that no longer exists is selected in the history, the previous object
is shown.
TIP: On the menu bar under Connection | Settings, you can specify
the number of database objects shown in the history. The history can be
deleted in the context menu using Clear history.

Related topics

l User interface on page 15

l Labeling changes on page 37
l Multilingual captions on page 44
l Testing a compilation on page 58

Status bar
The status bar displays different status data. Some status data is shown by way of icons.
Which icons are displayed is partially dependent on the program settings selected. The
status bar comes in different colors.

One Identity Manager 8.1.2 API Designer User and Development Guide
20
Working with the API Designer
Table 3: Meaning of the colors

Color Meaning

none Development environment database is connected.

Red Simulation mode is enabled.

Green Test environment database is connected.

Yellow Productive environment database is connected.

Table 4: Status bar icons

Icon Meaning

Shows the current user.

Shows information about the project.

The database is connected.

Shows database access.

The database must be compiled.

The program is in simulation mode.

On the status bar, the database is also shown in the following format:
<Server>/<Database (description)>
TIP: To copy the database path into the clipboard, double-click the database name in the
status bar.
To see more information about the current user, double-click the user name in
the status bar.

Related topics

l User interface on page 15

Navigation
Open the navigation using View | Navigation (see Opening the navigation on page 22).
Use the navigation to manage (create, open, delete) API files and API projects. You can
also access the most recently edited file here.
At the bottom of the navigation view, you can select whether you would like to manage API
files or API projects.
The following table provides an overview of the various features available within the
navigation.

One Identity Manager 8.1.2 API Designer User and Development Guide
21
Working with the API Designer
Table 5: Navigation features

Control Description

Add Adds a new database object. The type of database object

changes according to the pane you are in (API files or
API projects). For detailed information, see the
following sections:

l Creating API projects on page 68

l Creating API files on page 77

Delete Deletes a database object. For detailed information, see

the following sections:

l Deleting API projects on page 70

l Deleting API files on page 78

Reload data Refreshes the view/reloads the data.

Properties Opens the Object properties dialog. Allows you to view

the properties for the selected database object. For more
information, see Object properties on page 27.

Searching Uses the search feature to find specific database objects.

Enter the required search term and then press Enter.

Related topics

l User interface on page 15

l Creating API projects on page 68
l Creating API files on page 77
l Deleting API projects on page 70
l Deleting API files on page 78
l Object properties on page 27

Opening the navigation

By default, the navigation remains open (on the left side of the window) until you close it.
You can open the navigation again at any time.

To open the navigation

l On the menu bar, click View | Navigation.

One Identity Manager 8.1.2 API Designer User and Development Guide
22
Working with the API Designer
Related topics

l Navigation on page 21
l User interface on page 15

Start page
Open the start page from View | Start page (see Opening the start page on page 23).
The start page is displayed when the API Designer starts up.
On the start page, you can:

l Use compilation branches to store different versions of your API in the database.
l Test your API locally
l Compile the API and then write it to the database
l Use the API Designer to connect and edit C# projects

Related topics

l Managing versions (compilation branches) on page 62

l Testing an API on page 64
l Compiling an API on page 57
l Linking C# projects to the API Designer on page 65
l Opening the start page on page 23
l User interface on page 15

Opening the start page

You can open the start page again at any time.

To open the start page

l Click View | Start page on the menu bar.

The start page opens in the work pane.

Global settings
Open the global settings from Connection | Settings (see Changing global settings
on page 26).

One Identity Manager 8.1.2 API Designer User and Development Guide
23
Working with the API Designer
Use the Global settings dialog to configure basic settings for API Designer. The following
table gives an overview of the various features within the Global settings dialog.

Table 6: Global settings

Pane Setting Description

Common

Language

Current Displays the language currently in use for formatting data such
as date, time, or numbers.

After next Specify which language the API Designer will use for formatting
restart data such as date, time, or numbers. The next time the API
Designer starts up, the API Designer will use this language. For
more information, see Switching languages on page 26.

Use another Specify whether you want to use a different language for the API
language for Designer's user interface than the one configured for formatting
the UI values. Use the After next restart option to specify the
language for the user interface.
For example, you can continue using English for formatting data
but have German as the display language.

UI language

Current Shows the language currently in use.

After next Specifies the language for the API Designer. The next time the
restart API Designer starts up, the API Designer will use this language.
For more information, see Switching languages on page 26.

Resolution Specifies the resolution.

Maximum Specifies how many changes can be undone.

history length

Editor

Shorten long If you would like to shorten long property values, enable this
property option.
values

Show an error Enable this option if you want to receive a notification when
message if syntax errors have been found after editing.
syntax errors
are found after
editing

Save and load If you would like to save the size settings for the API Designer
API Designer view and reload them upon restarting, enable this option.
size within

One Identity Manager 8.1.2 API Designer User and Development Guide
24
Working with the API Designer
Pane Setting Description

layout

Ask for project Enable this option if you would like to select how you would like
type at each to save your project each time you start API Designer (see
start Changing the project type on page 12).

Compilation Use compilation branches to store different API versions in the

branch identi- database.
fier
Manage your compilation branches. You can select the compil-
ation branch that you want to use, display the existing compil-
ation branches, create compilation branches, edit compilation
branches, and delete compilation branches.
For more information, see Managing versions (compilation
branches) on page 62.

Compiler

Show following Specify which warnings are displayed as errors during compil-
warnings as ation. Enter the codes for the warnings, separated by commas.
errors The error codes refer to the Microsoft C# compiler. For more
information about compilation, see Compiling an API on page 57.
TIP: For information about error codes that occur during
compilation, you can refer, for example, to the Error code
table in the Tasks view (see Managing compilation errors and
warnings (task window) on page 60).

Ignore Specify which errors should be ignored during compilation. Enter

following the codes for the warnings, separated by commas. The error
warnings codes refer to the Microsoft C#Sharp compiler. For more inform-
ation about compilation, see Compiling an API on page 57.
TIP: For information about error codes that occur during
compilation, you can refer, for example, to the Error code
table in the Tasks view (see Managing compilation errors and
warnings (task window) on page 60).

Save and backup

Ask for change Enable this option if you would like to be asked for a change
label if none is label when saving.
selected

Keep backup If you would like to back up unsaved changes on your local hard
of unsaved drive, enable this option. This ensures that your changes are not
objects on the lost if the program crashes.
local machine

Keyboard layout

One Identity Manager 8.1.2 API Designer User and Development Guide
25
Working with the API Designer
Pane Setting Description

Show next Specify the shortcut to be used for the next bookmark.
bookmark
TIP: To specify a Ctrl or Shift shortcut, enable the Alt and/or
Ctrl options. Finally, select a button from the list.

Set/delete Specify the shortcut you want to use to set or remove a

bookmarks bookmark.
TIP: To specify a Ctrl or Shift shortcut, enable the Alt and/or
Ctrl options. Finally, select a button from the list.

Related topics

l Changing global settings on page 26

l Menu bar on page 16

Changing global settings

You can change the global settings, general settings, or both for the API Designer
at any time.

To adjust API Designer settings

1. On the menu bar, click Connection | Settings.

2. In the Global settings dialog, click a pane to collapse or expand it.
3. Configure the required settings (see Global settings on page 23).
4. Click Apply.

Related topics

l Global settings on page 23

Switching languages
The API Designer is available in German and English. You can switch between these
languages at any time. Changing the language requires the API Designer to be restarted.

To change the API Designer language

1. On the menu bar, select Connection | Settings.

2. In the Global settings dialog, in the Common | Common culture section, select
the desired language (for formatting and user interface) in the After next restart

One Identity Manager 8.1.2 API Designer User and Development Guide
26
Working with the API Designer
 menu.
3. (Optional) If you want to use another language for formatting values in the user
interface, set the Use another language for the UI option and select the desired
language in the After next restart menu.

For example, if you want dates to be displayed in the German format

([Link]) and the rest of the user interface in English, select German
(Germany) in step 2 and English (United States) in step 3.

4. Click Apply.
5. Confirm the prompt by selecting Yes in the Restart API Designer dialog.
The API Designer will restart in the selected language.

Related topics

l Global settings on page 23

Database objects
API projects, and API files are defined as database objects in API Designer. Here you can
learn how to work with these database objects in API Designer.

Related topics

l Editing database objects (definition tree view) on page 30

l Managing objects in a project (solution) on page 29
l Object properties on page 27

Object properties
Right-click on an object to open the Object properties dialog (see Displaying object
properties on page 28)
The Object properties dialog displays the properties of objects in the API Designer. The
dialog is divided into five tabs, which are explained below.

General

Under the General tab, the general properties of the object such as ID, status, or primary
key are displayed.

One Identity Manager 8.1.2 API Designer User and Development Guide
27
Working with the API Designer
Properties

Under the Properties tab, all columns in the database object are displayed in a table
alongside their values. You can choose between a simple column view or the advanced
view with additional data for column definitions.

Permissions

On the Permissions tab, the database object permissions are displayed. The first entry
shows the basic permissions for the table. Under that, the permissions are listed for the
specific database object. The other entries show the column permissions.
TIP: Double-click the table entry, the object entry, or a column entry to display the
permissions group from which the permissions were determined.

Table 7: Icon used for permissions

Icon Meaning

Permissions exist.

Permissions have been removed by the object layer.

Permissions limited by conditions.

Label

Under the Change labels tab, all the change labels assigned to the database object are
displayed. You can also assign a change label to the object.

Export

Under the Export tab, you can export the database object:

l To the clipboard
l As a file
l Using drag-and-drop
l As a SQL INSERT statement or SQL UPDATE statement

Related topics

l Displaying object properties on page 28

Displaying object properties

You can display the properties of a database object at any time.

One Identity Manager 8.1.2 API Designer User and Development Guide
28
Working with the API Designer
To display the properties of a database object

1. On the menu bar, click View | Navigation.

2. In the navigation, click the database object whose properties you would like
to display.
3. Click Properties .
The Object properties dialog opens. This dialog contains several tabs displaying
the properties of the selected database object. For more information, see Object
properties on page 27.

Related topics

l Object properties on page 27

Managing objects in a project (solution)

Open the Solution view using View | Solution (see Opening the solution on page 30).
The solution can be used to display all the objects in the API Designer that can be opened
from the navigation menu.
The solution view depends on your choice of project. If you select a solution project when
starting the API Designer, the listed entries will be grouped according to their respective
database modules and you will be able to disable the compilation of individual database
modules. Database modules whose status has not changed, are shown as collapsed nodes.
If you mark a subnode, you can run additional tasks.
You can also identify the objects whose status has changed in API Designer. Differences
between changes in the API Designer and changes to resources in the database or on the
hard disk are marked.
To open an object, double-click it in the solution.
The following table provides an overview of the various features available in the
Solution window.

Table 8: Controls

Control Description

Update list Refreshes the list of database objects.

Reload selected objects Reloads the selected objects.

Mark all modified Any objects that you have modified will be reloaded after
objects to be reloaded you click Reload selected objects.

Disable module compil- Disables compilation of the selected module.

ation

Only display modified Only modified objects will be displayed in the list.
objects

One Identity Manager 8.1.2 API Designer User and Development Guide
29
Working with the API Designer
Table 9: Solution columns

Column Description

Object Name of the object

identifier

DB status Up to date is displayed when the database has been refreshed. Otherwise,
the user who made the change is displayed.

Status drive Up to date is displayed when the file has been updated. Otherwise, a time
when the changes will be made is shown.

Status API Displays object modifications.

Designer
The status is shown as Changed if the object has been changed.

Reload A check box is displayed for new objects. You can reload selected objects.

Path Shows storage location of the file on the hard drive.

Related topics

l Opening the solution on page 30

l Menu bar on page 16

Opening the solution

You can open the solution at any time.

To open the solution

l Click View | Solution on the menu bar.

Related topics

l Managing objects in a project (solution) on page 29

Editing database objects (definition tree

view)
Open the definition tree view over View | Navigation | Click the required database
object (see Opening the definition tree view on page 31).
Use the definition tree view to display and edit different database objects in API Designer.
A separate tab containing a unique definition tree view will be opened for each database
object that you edit. A definition tree view opens when adding or editing database objects,
for example.

One Identity Manager 8.1.2 API Designer User and Development Guide
30
Working with the API Designer
A database object contains what are known as nodes, which you can display in a tree
structure within the definition tree view and edit in the node editor view (see Node
editor view on page 35). If you add a new database object to your project (for example,
an API project), this database object is created with a predefined number of nodes and
is shown in the object definition. The object definition is a type of view found within the
definition tree view.
The predefined nodes contained in a database object form the basic structure of the
database object. You cannot delete these nodes.
In addition to the predefined nodes, you can add extra nodes by right-clicking on the
context menu. You can delete these nodes.
The following table gives an overview of the various features contained on the toolbar
within the definition tree view.

Table 10: Definition tree view toolbar

Icon Description

Object An overview of nodes contained in a database object can be found here.

definition

You can view the code generated for a selected node here. For more
Generated information, see Viewing and saving generated code belonging to a node on
code page 34.

Find You can search for terms here and replace them where necessary. For more
and information, see Find and replace on page 40.
replace

Related topics

l Opening the definition tree view on page 31

l Viewing and saving generated code belonging to a node on page 34
l Find and replace on page 40

Opening the definition tree view

You can open the definition tree view at any time.

To open the definition tree view of a database object

1. On the menu bar, click View | Navigation.

2. In the navigation, double-click on the database object which holds the definitions you
would like to display.
The definition tree view for the selected object opens in a separate tab.

One Identity Manager 8.1.2 API Designer User and Development Guide
31
Working with the API Designer
Related topics

l Editing database objects (definition tree view) on page 30

l Navigation on page 21

Context menu in the definition tree window

To access the context menu, right-click a node in the definition tree window. The options
available in the menu depend on the type of node selected (context-sensitive).

Structure

The top section of the context menu lists the node types that can be added to the
selected node.
Some node types do not allow additional node types to be pasted into them. In such cases,
the Object in extension function is at the top of the context menu. All other functions are
either available or grayed out, depending on the type of node and its position in the
definition tree window.

Table 11: Functions in the context menu

Function Description

Object in Allows you to create sub-elements of the selected node in an extension

extension instead of an object.

Move to Moves the selected node into a new or existing extension.

extension

Cut Cuts the highlighted node and copies it to the clipboard.

Any child nodes for the selected node are also cut.
NOTE: You cannot cut any nodes that have been automatically added to
the definition tree.

Copy Copies the highlighted and child nodes to the clipboard.

Paste Pastes the node contained in the clipboard.

NOTE: You can only paste nodes contained in the clipboard if they are
also permitted at the selected point. Example: You cannot paste a Plugin
node below the Compilation settings node.

Delete Deletes the highlighted node and all child nodes.

NOTE: You cannot delete any nodes that have been automatically added
to the definition tree.
TIP: You can select multiple nodes by holding down the Ctrl key to apply
the function once to all selected nodes.

One Identity Manager 8.1.2 API Designer User and Development Guide
32
Working with the API Designer
Function Description

Delete node Deletes the highlighted node as an extension.

as an
extension

Sets or removes a bookmark on the highlighted node. For more inform-

Set/remove ation, see Bookmarks on page 55.
bookmark

Expand all Expands all nodes.

Collapse all Collapses all nodes.

Export Saves the selected node and their child nodes in XML format to your hard
drive.

Import Pastes previously exported child nodes at the selected point.

NOTE: You can only paste nodes if they are also permitted at the selected
point. Example: You cannot paste a Plugin node below the Compilation
settings node.

Move up Moves the selected node upwards.

NOTE: You cannot move any nodes that have been automatically added
to the definition tree.

Move Moves the selected node downwards.

down
NOTE: You cannot move any nodes that have been automatically added
to the definition tree.

Undo Undoes the previous action.

Redo Redoes the last action that has been undone.

Search Searches for all references that refer to the selected node.
object refer-
NOTE: If searching for a reference within a collection, the results are
ences
grouped by related columns.

Search Opens the Find and replace dialog. For more information, see Find and
replace on page 40.

Search This function continues the search using the current search parameters and
next highlights the next matching node. The search is executed even if the
Search dialog is not open.

Related topics

l Editing database objects (definition tree view) on page 30

l Bookmarks on page 55
l Find and replace on page 40

One Identity Manager 8.1.2 API Designer User and Development Guide
33
Working with the API Designer
Extensions
Use extension to indirectly edit base objects (standard database objects that are
contained in your project). You can add as many extensions as you wish to the base
objects in the API Designer.
Extensions are edited when you configure the base objects. This means you add an
extension to the object and change the property value. The base object is
subsequently compiled and the modification resulting from the extension is highlighted
in the API Designer.
Base objects to which you want to add an extension can be identified as colored nodes in
the Object definitions view in the Definition tree view.

Figure 1: Workflow in the API Designer

Viewing and saving generated code belonging to

a node
In the Definition tree view, you can view a node's generated code (within a database
object) and copy or save where necessary.
This function is particularly useful if you are looking at code in detail and want to reuse
parts of the code, or you want to examine an error in more detail.
NOTE: You cannot edit the code.
NOTE: If you want to search for a specific point in the code, you can use the
shortcut Ctrl + F.

To view a node’s generated code

1. On the menu bar, click View | Navigation.

2. In the navigation, double-click the database object that contains the node you
require.
3. Click the node in the definition tree view whose code you want to see.

One Identity Manager 8.1.2 API Designer User and Development Guide
34
Working with the API Designer
 4. Click .
The code will be displayed in a code view.

To save the generated code as a file

1. Execute the steps previously described.

2. In the code view, select the code that you want to save.
3. Right-click the highlighted code.
4. Click Copy.
5. Click Save as in the context menu.
6. Select a name and location for the file in the save dialog and click Save.

Related topics

l Editing database objects (definition tree view) on page 30

l Resolving errors and warnings on page 61

Node editor view

Open the node editor view using View | Node editor (see Opening the node editor view
on page 36).
The Node editor view allows you to edit the properties of a node that you have selected in
the Definition tree view (see Editing nodes on page 37).
NOTE:The settings shown depend on the type of node selected.
The following table provides an overview of the various features available within the Node
editor window.

Table 12: Controls

Control Description

and name / Displays if a file-based database object (Solution project) has been
icon of the selected.
base object
Click Open corresponding folder to open the folder on your drive
where the database object is located.
For more information, see Solution projects on page 13.

Node Shows the node identifier and the node type icon that marks it in the defin-
name/node ition tree view.
type icon

Database Displays if a database object is selected.

Delete Deletes the filter entered into the next field.

One Identity Manager 8.1.2 API Designer User and Development Guide
35
Working with the API Designer
Control Description

filter

Filter field Displays only fields that match the text that has been entered.
Example: If you enter Pe, only the Permission field will be displayed.
NOTE: The API Designer only filters the settings fields and not the
values contained within them.

Sort Sorts the settings alphabetically in ascending order within each category.
ascending
If you enable sorting, the button will be highlighted with a colored frame.
alphabetically

Sort Sorts the settings alphabetically in descending order within each

descending category.
alphabetically
If you enable sorting, the button will be highlighted with a colored frame.

View Enables/disables the display of the various settings in categories.

grouping
If you enable this option, the button will be highlighted with a colored
frame.

Expand all Expands all categories.

Collapse Collapses all categories.

all

Show Highlights settings that have had an extension added to them. Use to
extension switch to the extension. A node that has had an extension added to it, is
values indicated in the definition tree view with the icon.
If you enable this option, the button will be highlighted with a colored
frame.

Related topics

l Opening the node editor view on page 36

l Editing nodes on page 37
l Menu bar on page 16
l Editing database objects (definition tree view) on page 30

Opening the node editor view

You can open the node editor view at any time.

To open the node editor view

l Click View | Node editor on the menu bar.

One Identity Manager 8.1.2 API Designer User and Development Guide
36
Working with the API Designer
Related topics

l Editing nodes on page 37

l Node editor view on page 35

Editing nodes
Node properties can be edited for any node in the node editor view.

To edit a node

1. On the menu bar, click View | Navigation.

2. In the navigation, double-click the object that you would like to edit.
3. Click View | Node editor on the menu bar.
The Node editor view opens.
4. In the Definition tree view, click the node that you would like to edit.
The fields and options shown in the node editor view will change depending on the
selected node.
5. Make the changes in the Node editor view.
6. On the toolbar, click Save.

Related topics

l Opening the node editor view on page 36

l Node editor view on page 35
l Editing database objects (definition tree view) on page 30
l Menu bar on page 16
l Navigation on page 21

Labeling changes
Use Change label to make it easier to view and assign changes in the database. Any
database objects that yield a project are entered on a change label. Database Transporter
is used for moving the web project. You can create and edit change labels in different One
Identity Manager tools.

Related topics

l Using change labels on page 38

l Creating a change label on page 38

One Identity Manager 8.1.2 API Designer User and Development Guide
37
Working with the API Designer
 l Change management on page 39
l Deleting change labels on page 40

Using change labels

In order to also be able to assign a change label to changes, you need to select a change
label for further use.

To use a change label

l On the toolbar, select the required change label in the Change label list.
Any changes stored in the project during this session will be assigned to the selected
change label.
TIP: If you always use the same change label and do not want to select it every
time you start the API Designer, click Use the current change label as
default in the toolbar.

Related topics

l Labeling changes on page 37

l Creating a change label on page 38
l Change management on page 39
l Deleting change labels on page 40

Creating a change label

You can create as many change labels as you wish and use them to track your changes.

To edit a change label

1. In the toolbar, click Manage change label.

2. Click Create a new change label in the Change label dialog.
3. Specify the properties of the change label in the right-hand column in the list:
l Change label: Enter a name for the change label.
l Description: (Optional) Enter a description for the change label.
l Locked: (Optional) Select whether you would like to block the change label
from further use. If a change label is locked, no further changes can be booked
to this label.
l Comment: (Optional) Enter a comment to monitor changes to the
change label.

One Identity Manager 8.1.2 API Designer User and Development Guide
38
Working with the API Designer
 l Status: (Optional) Select a status from the list.
l Status comments: (Optional) Enter a comment in relation to the status.
l Parent change label: (Optional) Select a change label from the list to
be the parent.
4. Click Save change label above the list.
5. Click OK.

Related topics

l Labeling changes on page 37

l Using change labels on page 38
l Change management on page 39
l Deleting change labels on page 40

Change management
You can edit existing change labels at any time.

To edit a change label

1. In the toolbar, click Manage change label.

2. In the Change label dialog, click the label to be edited.
3. Click Show / hide edit view.
4. Change the properties of the change label in the right-hand column in the list:
l Change label: Enter a name for the change label.
l Description: (Optional) Enter a description for the change label.
l Locked: (Optional) Select whether you would like to block the change label
from further use. If a change label is locked, no further changes can be booked
to this label.
l Comment: (Optional) Enter a comment to monitor changes to the
change label.
l Status: (Optional) Select a status from the list.
l Status comments: (Optional) Enter a comment in relation to the status.
l Parent change label: (Optional) Select a change label from the list to
be the parent.
5. Click Save change label above the list.
6. Click OK.

One Identity Manager 8.1.2 API Designer User and Development Guide
39
Working with the API Designer
Related topics

l Labeling changes on page 37

l Using change labels on page 38
l Creating a change label on page 38
l Deleting change labels on page 40

Deleting change labels

You can delete existing change labels at any time.

To edit a change label

1. In the toolbar, click Manage change label.

2. In the Change label dialog, click the change label you would like to delete.
3. Click Delete the selected change label.
4. Confirm the prompt by selecting Yes in the dialog.
5. Click Cancel.

Related topics

l Labeling changes on page 37

l Using change labels on page 38
l Creating a change label on page 38
l Change management on page 39

Find and replace

Open the search function over Edit | Find and replace (see Running a search on
page 43).
Use the Find and replace dialog to search for (and replace) certain captions or items
within your project. The following table gives an overview of the various features within
the Find and replace dialog.

Table 13: Controls for find and replace

Control Description

Find Enter the term to be found.

TIP: To reuse terms from previous searches, click the arrow to the

One Identity Manager 8.1.2 API Designer User and Development Guide
40
Working with the API Designer
Control Description

right of the field and select the required term.

Find as Select whether you would like to search using simple text or by
wildcards or regular expressions.

Replace by (Optional) Enter the text that will replace the text found.

Find scope If you would like to further narrow the search, you can select which
objects you would like to search for here:

l Current document: Only the current document is included in

the search.
l Current document and its extensions: Only the current
document and all of its extensions are included in the search.
l Current document and its parent documents: Only the
current document and all of its parent items are included in the
search.
l Below the selected object: Only the objects below the
current object are included in the search.
l All API Designer objects: All objects are included in the
search.

Find options Configure other search settings:

l Case sensitive: API Designer finds only occurrences of the

text that match the case that you have entered into the Find
field.
l Whole word: Only the whole word is included in the search.
Example: If you enter Person, the search will only find
“person” and not “persons.”
l Match entire value: API Designer finds only objects
containing the exact values that match the text you have
entered into the Find field.
l Filter by type: Select the objects to which your search will be
limited.

Find Finds and opens the next occurrence of the term.

Find all Triggers a search that lists all occurrences of the text in the Find
results pane.

Find results Lists all occurrences of the term.

Replace Replaces the occurrence of the term that you have highlighted in Find
results with the text that you have entered in the Replace by field.

Replace all Replaces all occurrences of the term that you have selected in the
Replace column under Find results with the text that you have
entered in the Replace by field.

One Identity Manager 8.1.2 API Designer User and Development Guide
41
Working with the API Designer
Wildcards

Use wildcards to replace a single character, or a string of characters, using a single

character when searching for strings. The most common wildcards are the question mark
(?), to symbolize an individual character, and the asterisk (*), to symbolize any
combination of characters.
To use wildcards in the Find and replace dialog, enter the search term into the Find field
and select the Wildcards option from the Find as list.

Examples
The following table gives some examples of wildcard searches:

Sample term Result

P*n Finds "person," "position," "plugin," and so on.

Per* Finds "person," "personal," "perfection," and so on.

AP?.json Finds "[Link]" but not "[Link]."

Regular expressions

Regular expressions (also known as "regex" or "regexp") are similar to wildcards in that
they also allow you to find strings. Regular expressions are more effective than
wildcards, however.
To use regular expressions in the Find and replace dialog, enter the search term into the
Find field and select the Regular expressions option from the Find as list.

Examples
The following table gives some examples of regular expressions:

Regular Description
expression

[a-z] Any lowercase Latin letter

[A-Z] Any uppercase Latin letter

\d A digit

\D A character that is not a digit

\w A letter, a digit, or an underscore

One Identity Manager 8.1.2 API Designer User and Development Guide
42
Working with the API Designer
 Regular Description
expression

\W A character that is neither a letter, a number, nor an underscore

\s Blank space

\S A character that is not a blank space

{n} The preceding term must occur exactly "n" number of times.
Example: C{3} finds "CCC”

| Alternatives
Example: Regex|Regexp finds "Regex" or "Regexp”

? The preceding term is optional, it can occur once, but does not need
to, that is, the term either occurs once or not at all.

Related topics

l Running a search on page 43

l Menu bar on page 16

Running a search
You can perform a search of the whole project, or parts of it, at any time.

To run a search

1. Click Edit | Find and replace on the menu bar.

2. In the Find and replace dialog, enter a search term in the Find field.
3. In the Find as list, select whether you would like to search using simple text or by
wildcards or regular expressions.
4. (Optional) In the Replace by field, enter the text to replace the text in the search.
5. In the Find scope list, select which objects you would like to include in the search.
6. (Optional) In the Find options pane, click Expand to configure further
search settings.
7. Click Find or Find all.
The search results are displayed in the Find results pane
8. In the Find options pane, click Expand to configure further search settings.
9. (Optional) Double-click a result in the results list.

One Identity Manager 8.1.2 API Designer User and Development Guide
43
Working with the API Designer
 This marks and displays the corresponding nodes in the definition tree view.
10. (Optional) To replace a result, highlight it in the Find results pane and click
Replace.
11. (Optional) To replace several results, enable the checkbox next to the relevant
results and click Replace all.

Related topics

l Find and replace on page 40

Multilingual captions
Open the Multilingual captions dialog using Captions.
Use the Multilingual captions dialog to add, edit, or delete captions in multiple
languages. You can use this text later in your API or web application.
Before adding or editing multilingual captions, define objects in your project that output
captions in your API. You create keys for these objects. You assign a text to the keys for
each language. This means that the keys are translated into the different languages you
wish to use.
You can create and edit keys and translations on the Captions tab in the Multilingual
captions dialog The following table gives an overview of the various features within the
Multilingual captions dialog.

Table 14: Controls

Control Description

Add Creates a new caption. For more information, see Creating multilingual
captions on page 45.

Deletes the caption selected in the results list. For more information, see
Delete Deleting a multilingual caption on page 47.

Save Saves the changes. For more information, see Editing a multilingual caption on
page 46.

Search In this pane, you can search for existing captions and edit them. For more
mask information, see Searching for a multilingual caption on page 45.

Result Lists the results generated by the search. For more information, see Searching
list for a multilingual caption on page 45.

Handling You can edit captions in this pane. For more information, see Creating multi-
lingual captions and Editing a multilingual caption on page 46.

One Identity Manager 8.1.2 API Designer User and Development Guide
44
Working with the API Designer
Related topics

l Creating multilingual captions on page 45

l Searching for a multilingual caption on page 45
l Editing a multilingual caption on page 46
l Deleting a multilingual caption on page 47
l Menu bar on page 16

Creating multilingual captions

You can create multilingual captions at any time.

To create a multilingual caption

1. Click Captions on the menu bar.

2. Click Add on the toolbar in the Multilingual captions dialog.
3. In the Edit pane, enter a unique value in the Key field to be used to
reference the text.
NOTE: If you have not added a translation for a language, the API will use the
caption that has been saved under Key.
4. Select the caption’s language in the Language list.
5. Enter the caption to be shown for the selected language in the Text field.
6. Repeat the previous two steps for all the required languages.
7. Click Save on the toolbar in the Multilingual captions dialog.
8. Click Apply.

Related topics

l Multilingual captions on page 44

l Searching for a multilingual caption on page 45
l Editing a multilingual caption on page 46
l Deleting a multilingual caption on page 47

Searching for a multilingual caption

You can search for multilingual captions at any time.

One Identity Manager 8.1.2 API Designer User and Development Guide
45
Working with the API Designer
To search for a multilingual caption

1. Click Captions on the menu bar.

2. In the Multilingual captions dialog, enter a term into the Search form (such as
the name of a key or parts of the caption).
3. Use the options below the search bar to limit your search:
l Search key and value: Searches for the term in the key and captions.
l Search for key only: Only searches for the term in the key.
l Search for value only: Only searches for the term in the captions.
l Search in all available languages: Enable this option if you would like to
search for the term across all languages. If you disable this option, the search
will only be performed in the language that is current shown in the Language
field in the Edit pane.
4. Click Search.
The search results are displayed in the Result list pane
TIP: If one of the Search key and value or Search for key only options is set,
the keys shown in the result list are labeled with an asterisk (*).

Related topics

l Multilingual captions on page 44

l Creating multilingual captions on page 45
l Editing a multilingual caption on page 46
l Deleting a multilingual caption on page 47

Editing a multilingual caption

You can edit existing multilingual captions at any time.

To edit a multilingual caption

1. Click Captions on the menu bar.

2. In the Multilingual captions dialog, enter the search term in the Search
form section.
3. Use the options below the search bar to limit your search:
l Search key and value: Searches for the term in the key and captions.
l Search for key only: Only searches for the term in the key.
l Search for value only: Only searches for the term in the captions.
l Search in all available languages: Enable this option if you would like to

One Identity Manager 8.1.2 API Designer User and Development Guide
46
Working with the API Designer
 search for the term across all languages. If you disable this option, the search
will only be performed in the language that is current shown in the Language
field in the Edit section.
4. Click Search.
5. In the Result list section, click the caption to be edited.
TIP: If one of the Search key and value or Search for key only options is set,
the keys shown in the result list are labeled with an asterisk (*).
6. In the Edit section, change the unique value in the Key field that is used to
reference the text.
NOTE: If you have not added a translation for a language, the API will use the
caption that has been saved under Key.
7. Select the caption’s language in the Language list.
8. Enter the caption to be shown for the selected language in the Text field.
9. Repeat the last two steps for any languages that you would like to change or add.
10. Click Save on the toolbar in the Multilingual captions dialog.
11. Click Apply.

Related topics

l Multilingual captions on page 44

l Creating multilingual captions on page 45
l Searching for a multilingual caption on page 45
l Deleting a multilingual caption on page 47

Deleting a multilingual caption

You can delete existing multilingual captions at any time.
NOTE: You cannot delete multilingual captions that have been predefined by API
Designer.

To delete a multilingual caption

1. Click Captions on the menu bar.

2. In the Multilingual captions dialog, enter a term into the Search parameters
(such as the name of a key or parts of the caption).
3. Use the options below the search bar to limit your search:
l Search key and value: Searches for the term in the key and captions.
l Search for key only: Only searches for the term in the key.
l Search for value only: Only searches for the term in the captions.

One Identity Manager 8.1.2 API Designer User and Development Guide
47
Working with the API Designer
 l Search in all available languages: Enable this option if you would like to
search for the term across all languages. If you disable this option, the search
will only be performed in the language that is current shown in the Language
field in the Edit section.
4. Click .
5. In the Result list section, click the caption to be deleted.
TIP: If one of the Search key and value or Search for key only options is set,
the keys shown in the result list are labeled with an asterisk (*).
6. Click Delete on the toolbar in the Multilingual captions dialog.
7. Confirm the prompt by selecting Yes in the dialog.
8. Click Apply.

Related topics

l Multilingual captions on page 44

l Creating multilingual captions on page 45
l Editing a multilingual caption on page 46
l Searching for a multilingual caption on page 45

Managing database queries

Open the Edit database queries dialog over Edit | Edit database queries (see
Displaying database queries on page 49).
In the Edit database queries dialog, you can display, create, edit, delete, and test
database queries.
Database queries enable secure communication between your web application and your
One Identity Manager database. The actual SQL code is saved in SQL snippets, to which
only certain parameters can be added later. The database queries are referenced later in
the code only based on their name.
The following table gives an overview of the various features within the Edit database
queries dialog.

Table 15: Controls

Control Description

Add Creates a new database query. For more information, see Creating a
database query on page 50.

Delete Deletes the selected database query. For more information, see Deleting a
database query on page 52.

One Identity Manager 8.1.2 API Designer User and Development Guide
48
Working with the API Designer
Control Description

Save Saves changes to the selected database query. For more information, see
Editing a database query on page 50.

Save all Saves all changes. For more information, see Editing a database query on
page 50.

Discard Undoes all changes to the selected database query.

object
changes

Identifier Is a unique database query ID.

Description Gives a description of the database query that explains the query and its
function.

SQL expres- Is the actual query in SQL code.

sion

Dialog Are dialog groups that are permitted to use this database query (labeled
groups ) or forbidden from using it (labeled ).

Test Opens the Test statement dialog. You can test the database query here.
statement For more information, see Testing a database query on page 51.

Related topics

l Displaying database queries on page 49

l Creating a database query on page 50
l Editing a database query on page 50
l Testing a database query on page 51
l Deleting a database query on page 52

Displaying database queries

You can edit all existing database queries at any time.

To show all database queries

l Click Edit | Edit database queries on the menu bar.

Related topics

l Managing database queries on page 48

l Editing a database query on page 50

One Identity Manager 8.1.2 API Designer User and Development Guide
49
Working with the API Designer
 l Testing a database query on page 51
l Deleting a database query on page 52

Creating a database query

You can create new database queries at any time.

To create a database query

1. Click Edit | Edit database queries on the menu bar.

2. Click Add in the Edit database queries dialog.
3. Enter a unique name for the database query in the Identifier field.
4. (Optional) In the Description field, enter a description for the database query that
describes the database query and its function.
5. Enter the query as a SQL code in the SQL expression field.
6. Double-click the dialog groups that may use the database query in the Dialog
groups pane.
TIP: Click Select all or Deselect all to quickly select or deselect all
dialog groups.
7. (Optional) Click Test statement to test the SQL statement with different values. For
more information, see Testing a database query on page 51.
8. Click Save.
9. Click Close.

Related topics

l Managing database queries on page 48

l Displaying database queries on page 49
l Editing a database query on page 50
l Testing a database query on page 51
l Deleting a database query on page 52

Editing a database query

NOTE: You cannot edit any database queries that have been predefined by the
API Designer.
You can edit existing database queries at any time.

One Identity Manager 8.1.2 API Designer User and Development Guide
50
Working with the API Designer
To edit a database query

1. Click Edit | Edit database queries on the menu bar.

2. Click the database query you would like to edit in the Edit database queries dialog.
3. Enter a unique name for the database query in the Identifier field.
4. (Optional) In the Description field, enter a description for the database query that
describes the database query and its function.
5. Enter the query as a SQL code in the SQL expression field.
6. In the Dialog groups section, double-click the dialog groups for which access
permissions are to be changed.
TIP: Click Select all or Deselect all to quickly select or deselect all
dialog groups.
7. (Optional) Click Test statement to test the SQL statement with different values. For
more information, see Testing a database query on page 51.
8. Click Save.
9. Click Close.

Related topics

l Managing database queries on page 48

l Displaying database queries on page 49
l Creating a database query on page 50
l Testing a database query on page 51
l Deleting a database query on page 52

Testing a database query

You can test database queries at any time.

To test a database query

1. Click Edit | Edit database queries on the menu bar.

2. In the Edit database queries dialog, click the database query you would
like to test.
3. Click Test statement.
4. In the Test statement dialog, enable the check box next to the SQL statement
parameters that you would like to include in the test.
5. Enter the values for each parameter in the Value column.
6. Click Test statement.

One Identity Manager 8.1.2 API Designer User and Development Guide
51
Working with the API Designer
 7. Click Close.
8. Click Close in the Edit database queries dialog.

Related topics

l Managing database queries on page 48

l Displaying database queries on page 49
l Creating a database query on page 50
l Editing a database query on page 50
l Deleting a database query on page 52

Deleting a database query

NOTE: You cannot delete any database queries that have been predefined by the API
Designer. The Delete button is disabled for such database queries.
You can delete existing database queries at any time.

To delete a query

1. Click Edit | Edit database queries on the menu bar.

2. Click the database query you would like to delete in the Edit database
queries dialog.
3. Click Delete.
4. Confirm the prompt by selecting Yes in the dialog.
5. Click Close in the Edit database queries dialog.

Related topics

l Managing database queries on page 48

l Displaying database queries on page 49
l Creating a database query on page 50
l Editing a database query on page 50
l Testing a database query on page 51

Managing tabs
Use the Tabs dialog to enable opened tabs, close tabs, or save changes that you have
made in tabs.

One Identity Manager 8.1.2 API Designer User and Development Guide
52
Working with the API Designer
To manage tabs

1. Click View | Tabs on the menu bar.

2. Clicke or more tabs (while holding down the Ctrl key) in the Tabs dialog.
3. Perform one of the following tasks:
l Click Enable to enable the tab.
l Click Save to save tab changes.
l Click Close tabs to close the tab.
4. Click Close.

Related topics

l Menu bar on page 16

Managing layouts
You can adjust, save, and, where necessary, restore the layout (assign and show different
menus and panes) at any time.

To save your own layout

1. Customize the layout of the API Designer to suit your needs.

2. Click View | Save layout on the menu bar.

To restore a saved layout

l Click View | Restore saved layout on the menu bar.

To restore the default layout

l Click View | Restore standard layout on the menu bar.

To restore the default layout including the window size

l Click View | Restore standard layout (including size) on the menu bar.

Related topics

l Menu bar on page 16

One Identity Manager 8.1.2 API Designer User and Development Guide
53
Working with the API Designer
Displaying the change history
(command list)
Open the command list using View | Command list (see Opening the command list
on page 54).
Use the Command list window to display any changes made to an object and to either
undo or redo them.
Executed commands are indicated with the icon. This icon is not shown for commands
that were undone.
The use of wizards allows numerous commands to be automatically implemented, which in
the command list are displayed as composite commands and the individual commands are
shown at a second level. You can only undo the composite commands.
The following table gives an overview of the various features available in the Command
list window.

Table 16: Controls

Control Description

Undo Undoes the last implemented command in the list.

Redo Redoes the last command in the list that was undone.

Related topics

l Opening the command list on page 54

Opening the command list

You can view a list of actions that have been taken at any time.

To open the command list

l Click on View | Command list on the menu bar.

Related topics

l Displaying the change history (command list) on page 54

One Identity Manager 8.1.2 API Designer User and Development Guide
54
Working with the API Designer
Bookmarks
Open the Bookmarks window using View | Bookmarks (see Editing bookmarks on
page 55).
To make navigating around the API Designer easier and to find objects quickly, you can set
bookmarks to any node in the Definition tree view. View, manage, and use these
bookmarks in the Bookmarks window.
The following table provides an overview of the various features available within the
Bookmarks window.

Table 17: Controls

Control Description

Delete all Deletes all bookmarks (see Deleting bookmarks on page 57).
bookmarks

Edit bookmark Opens a dialog that allows you to change the description of the
description selected bookmark (see Editing bookmarks on page 55).

Remove module/- Deletes all bookmarks for the module (or component) selected in
component bookmark the list (see Deleting bookmarks on page 57).
NOTE: This feature is only available if you selected to group the
bookmarks by module/component earlier (see Group by
modules/components) button.

Delete current Deletes the bookmark that you have selected in the list (see
bookmark Deleting bookmarks on page 57).

Group by modules/- Groups the bookmarks by the API projects to which they are
components assigned.

Related topics

l Editing bookmarks on page 55

l Setting bookmarks on page 56
l Deleting bookmarks on page 57

Editing bookmarks
You can show all bookmarks, delete all bookmarks, or change the description of
bookmarks at any time.

One Identity Manager 8.1.2 API Designer User and Development Guide
55
Working with the API Designer
To open the bookmark window

l Click View | Bookmarks on the menu bar.

To open a bookmark

1. Click View | Bookmarks on the menu bar.

2. Double-click a bookmark in the Bookmarks window.

To edit the bookmark description

1. Click View | Bookmarks on the menu bar.

2. Click a bookmark in the Bookmarks window.
3. Click Edit bookmark description.
4. Insert a description for the bookmark in the Bookmark description dialog.
5. Click OK.

Related topics

l Bookmarks on page 55
l Setting bookmarks on page 56
l Deleting bookmarks on page 57

Setting bookmarks
You can set a bookmark for database objects at any time. This allows you to do things such
as quickly access frequently used nodes.

To set a bookmark

1. On the menu bar, click View | Navigation.

2. In the navigation, double-click the database object that contains the node you
require.
3. In the definition tree view, right-click the node for which you would like to
set a bookmark.
4. Click Set bookmark in the context menu.
5. Insert a description for the bookmark in the Bookmark description dialog.
6. Click OK.

Related topics

l Bookmarks on page 55
l Editing bookmarks on page 55

One Identity Manager 8.1.2 API Designer User and Development Guide
56
Working with the API Designer
 l Deleting bookmarks on page 57

Deleting bookmarks
You can delete single bookmarks, all bookmarks within a module, or all bookmarks within
a project at any time.

To delete a single bookmark

1. Click View | Bookmarks on the menu bar.

2. Click the bookmark that you would like to delete in the Bookmarks window.
3. Click Delete current bookmark.
4. Confirm the prompt by selecting Yes in the dialog.

To delete all the bookmarks in a module/component

1. Click View | Bookmarks on the menu bar.

2. Click Group by modules/components in the Bookmarks window.

3. Click the module whose bookmarks you would like to delete.
4. Click Remove bookmarks from module/component.
5. Confirm the prompt by selecting Yes in the dialog.

To remove all bookmarks

1. Click View | Bookmarks on the menu bar.

2. Click Delete all bookmarks in the Bookmarks window.
3. Confirm the prompt by selecting Yes in the dialog.

Related topics

l Bookmarks on page 55
l Editing bookmarks on page 55
l Setting bookmarks on page 56

Compiling an API
TIP: See additional configuration options for compilation directly on the API project (see
Configuring the compilation on page 74 and in the global settings).
Before you can use an API that has been created with the API Designer, the API must be
compiled using the API Designer compiler.

One Identity Manager 8.1.2 API Designer User and Development Guide
57
Working with the API Designer
The API Designer compiler can be opened from the API Designer, as well as from the
Database Compiler. For more detailed information about the Database Compiler, see the
One Identity Manager Operational Guide.
A web project must be compiled in the following cases:

l After changing a definition (API file or API project) in the API Designer
l After changing certain system settings that require Database Compiler to be run

The API Designer compiler creates a set of DLL files from the project's XML definition and
saves them in the database.

Methods of compiling

There are two ways to compile a web project:

l Run a Release compilation to release a specific version of the project for use.
NOTE: Changes within the API Designer do not affect the API as long as there is no
release compilation.
l Use a Debug compilation during the development phase for testing and debugging
purposes. Debug compilation creates additional code to support the API Designer
debugger. This means the DLL files are somewhat larger.

An API loads the latest compiled DLL files on startup. If these DLL files are updated, the
web project reloads the new DLL files; however, only new sessions run with the code from
the newly loaded DLLs.

Related topics

l Testing a compilation on page 58

l Starting a compilation on page 59
l Managing versions (compilation branches) on page 62
l Managing compilation errors and warnings (task window) on page 60
l Resolving errors and warnings on page 61
l Opening the compiling log on page 61
l Configuring the compilation on page 74
l Global settings on page 23

Testing a compilation
The two types of compilation (Debug and Release compilation) can be tested in advance.

One Identity Manager 8.1.2 API Designer User and Development Guide
58
Working with the API Designer
To test the compilation

1. On the menu bar, click View | Start page.

2. On the start page, expand the Compilation pane.
3. In the Compilation pane, perform one of the following actions:
l To test a debug compilation, enable the DEBUG option.
l To test a release compilation, enable the RELEASE option.
4. Click Test compilation.
The Compilation log opens and shows compilation status and progress.
The Tasks window opens. Use this to view and rectify any errors and warnings that
arise during compilation. For more information, see Managing compilation errors and
warnings (task window) on page 60.

Related topics

l Compiling an API on page 57

l Managing compilation errors and warnings (task window) on page 60
l Menu bar on page 16

Starting a compilation
You can start two types of compilation (Debug and Release). If compilation completes
without any errors, then the compiled API is written to the database.

To start compilation

1. On the menu bar, click View | Start page.

2. On the start page, expand the Compilation pane.
3. In the Compilation pane, perform one of the following actions:
l To start a debug compilation, enable the DEBUG option.
l To start a release compilation, enable the RELEASE option.
4. Click Compile.
The Compilation log opens and shows compilation status and progress.
The Tasks window opens if errors arise. Use this to view and rectify any errors and
warnings that arise during compilation. For more information, see Managing
compilation errors and warnings (task window) on page 60.

Related topics

l Compiling an API on page 57

l Managing compilation errors and warnings (task window) on page 60

One Identity Manager 8.1.2 API Designer User and Development Guide
59
Working with the API Designer
 l Testing a compilation on page 58
l Menu bar on page 16

Managing compilation errors and warnings

(task window)
Open the task window with View | Tasks (see Opening the task window on page 61).
Use the Tasks window to view compilation errors and warnings and to rectify them where
necessary (debug).

l Compilation errors prevent the web project from compiling properly and must
therefore be eliminated. Development states cannot be released if they cannot
be compiled.
l Compilation warnings relate to missing extensions, or to messages concerning
accessibility. The compilation warnings of the relevant compiler are also taken into
account. If compiler warnings are the only type of message that is generated, the
development state will be successfully compiled nonetheless.

TIP: In the global settings, you can define which warnings are displayed as errors
during compilation and which errors are ignored. For more information, see Global
settings on page 23.
If individual messages are displayed ( icon) together, it means that the errors indicated
occur at various locations throughout the web project. This can happen, for example, if an
extension that is referenced by a number of nodes is missing.
The following table gives an overview of the various features in the Tasks window.

Table 18: Controls

Control Description

Errors Hides or displays compilation errors.

Hides or displays compilation warnings.

Warnings

Error Displays the error message. This button is only active if you have highlighted
details a listed error message.
Click this button to view a detailed description of the error.
Click Send as mail to transfer the error message to an email and send.

Related topics

l Opening the task window on page 61

l Resolving errors and warnings on page 61

One Identity Manager 8.1.2 API Designer User and Development Guide
60
Working with the API Designer
Opening the task window
You can open the task window at any time.

To open the task window

l Click View | Tasks on the menu bar.

Related topics

l Resolving errors and warnings on page 61

l Managing compilation errors and warnings (task window) on page 60

Resolving errors and warnings

If errors occur when compiling your API, the task view can be used to see and
resolve them.
TIP: In the global settings, you can define which warnings are displayed as errors
during compilation and which errors are ignored. For more information, see Global
settings on page 23.

To open and edit objects with errors in the task window

1. Click View | Tasks on the menu bar.

2. Click either Errors or Warnings in the task window.
3. Perform one of the following tasks:
l Double-click the listed error/warning and then resolve the error/warning within
the Node editor window itself.
NOTE: The node editor window opens if the node contains the error. If the
error occurs when the resulting code is compiled, you can double-click it to
display Generated code (read-only) in the definition tree view.
- OR -

l Click the error/warning in the list and then click Correct errors.

Related topics

l Opening the task window on page 61

l Managing compilation errors and warnings (task window) on page 60

Opening the compiling log

The compiling log displays compiling status and progress.

One Identity Manager 8.1.2 API Designer User and Development Guide
61
Working with the API Designer
To open the compiling log

l Click View | Compilation on the menu bar.

Related topics

l Compiling an API on page 57

l Menu bar on page 16

Managing versions (compilation

branches)
To manage different versions of your compiled API and save them in the database, you use
compilation branches. Compilation branches are managed in a separate pane on the start
page. Here you can select the compilation branch that you want to use, display the existing
compilation branches, create compilation branches, edit compilation branches, and delete
compilation branches.

Related topics

l Compiling an API on page 57

l Selecting and using compilation branches on page 62
l Creating compilation branches on page 63
l Editing compilation branches on page 63
l Deleting compilation branches on page 64

Selecting and using compilation branches

To select and use compilation branches

1. On the menu bar, click View | Start page.

2. On the start page, expand the Compilation branches pane.
3. In the Compilation branches pane, in the Compilation branch identifier list,
click the compilation branch that you want to use.
TIP: If you do not want to use a compilation branch, click Use master status.

Related topics

l Managing versions (compilation branches) on page 62

l Creating compilation branches on page 63

One Identity Manager 8.1.2 API Designer User and Development Guide
62
Working with the API Designer
 l Editing compilation branches on page 63
l Deleting compilation branches on page 64

Creating compilation branches

To use a compilation branch

1. On the menu bar, click View | Start page.

2. On the start page, expand the Compilation branches view.
3. In the Compilation branches view, click Manage name of branches.
4. In the Manage compilation branches window, click Add.
A new entry Unknown is added at the end of the list.
5. In the list, click Unknown.
6. In the Identifier field, enter a unique name for the compilation branch.
7. (Optional) In the Description field, enter a description for the compilation
branch. This description may explain, for example, the intended purpose of the
compilation branch.
8. Click Save.

Related topics

l Managing versions (compilation branches) on page 62

l Selecting and using compilation branches on page 62
l Editing compilation branches on page 63
l Deleting compilation branches on page 64

Editing compilation branches

To edit existing compilation branches

1. On the menu bar, click View | Start page.

2. On the start page, expand the Compilation branches pane.
3. In the Compilation branches pane, click Manage compilation branches.
4. In the Manage compilation branches dialog, click the compilation branch that you
want to edit in the list.
5. In the Identifier field, enter a unique name for the compilation branch.
6. (Optional) In the Description field, enter a description for the compilation branch.
This description may explain, for example, the intended purpose of the compilation

One Identity Manager 8.1.2 API Designer User and Development Guide
63
Working with the API Designer
 branch.
7. Click Save.

Related topics

l Managing versions (compilation branches) on page 62

l Selecting and using compilation branches on page 62
l Creating compilation branches on page 63
l Deleting compilation branches on page 64

Deleting compilation branches

To delete compilation branches

1. On the menu bar, click View | Start page.

2. On the start page, expand the Compilation branches pane.
3. In the Compilation branches pane, click Manage compilation branches.
4. In the Manage compilation branches dialog window, click the compilation branch
that you want to delete from the list.
5. Click Delete .
6. Confirm the Delete? prompt by selecting Yes.

Related topics

l Managing versions (compilation branches) on page 62

l Selecting and using compilation branches on page 62
l Creating compilation branches on page 63
l Editing compilation branches on page 63

Testing an API
You can test the functionality of your API locally on your PC at any time.

To test your API locally

1. On the menu bar, click View | Start page.

2. Expand the Self-hosted API Server pane on the start page.
3. In the Startup options field, enter the options for starting the API.
TIP: Alternatively, you can also select previous commands from the list.

One Identity Manager 8.1.2 API Designer User and Development Guide
64
Working with the API Designer
 4. Click Start.
The API is compiled and will then be available locally. The corresponding web
address is displayed next to the Status. Click the address to open this directly in
the browser.

Related topics

l Opening the start page on page 23

Linking C# projects to the API Designer

To edit an API as a C# project with external programs (for example, Visual Studio), you
must perform three steps:

1. Link your API Designer project with a new or existing C# project.

2. Edit the C# project in an external program.
3. Open the C# project again in API Designer and save it in the API project.

To link the API Designer project with a C# project

1. On the menu bar, click View | Start page.

2. On the start page, expand the C# development pane.
3. In the C# development pane, perform one of the following actions:
l To export and link the API Designer project as a new C# project, click
Export C# project. Navigate to the folder where you want to export the
content of your API Designer project as a C# project and click OK.
l To link the API Designer project with an existing project, click Load
C# project.
The API Designer is linked with the C# project.

To edit the C# project in an external program

1. On the menu bar, click View | Start page.

2. On the start page, expand the C# development pane.
3. In the C# development pane, click Project file: <path to C# project>.
The project opens in the program that the project file is linked with.
TIP: To open the project folder directly, click Open corresponding folder.
4. Edit the project in the external program. For example, you can create, change, or
delete API files.

One Identity Manager 8.1.2 API Designer User and Development Guide
65
Working with the API Designer
To save changes back to the API Designer project

1. Open the API Designer.

2. On the menu bar, click View | Start page.
3. On the start page, expand the C# development pane.
4. In the C# development pane, click Synchronize C# project with base.
You now see the objects that you have changed outside the API Designer.
5. In the list on the right, next to the changed objects, select the actions that you want
to perform for the API Designer project.

Status message Description Actions

New C# file A new API file was created Add API file: Adds the
in the C# project. C# file that you created in
the external program to
yourAPI Designer project
as an API file.
Delete file: Deletes the
C# class in the C#
project.

New API file A new API file was created Add C# file: Adds the
in the API Designer Sharp API file that you created
project. in the API Designer to
your C# project as a C#
file.
Delete API file: Deletes
the API file in the API
Designer project.

API file is newer An API file was modified in Update: Transfers the
the API Designer project. changes to the API file
from the API Designer
project into the C#
project.
Revert changes:
Reverses the changes that
you made in your API
Designer project in the
API file.

C# file is newer An API file was modified in Update: Transfers the

the C# project. changes to the API file
from the C# project into
the API Designer project.

One Identity Manager 8.1.2 API Designer User and Development Guide
66
Working with the API Designer
 Status message Description Actions

Revert changes:
Reverses the changes that
you made in your C#
project in the API file.

6. Select the check box next to the objects for which the selected actions should
be performed.
TIP: To quickly select or deselect all objects, select the Select all/deselect all
check box above the list.
7. Click Apply selected actions.

One Identity Manager 8.1.2 API Designer User and Development Guide
67
Working with the API Designer
 6

API projects

An API project represents the actual API application itself.

You can combine API files that you have created in one API project for a logical application.
The API project includes the configuration. The API project includes the authentication on
the database.

Related topics

l Creating API projects on page 68

l Editing API projects on page 69
l Deleting API projects on page 70
l Configuring authentication on page 71
l Configuring the compilation on page 74
l Assigning API files to an API project on page 78
l Importing API projects on page 75

Creating API projects

You can create new API projects at any time.

To create an API project

1. On the menu bar, click View | Navigation.

2. Click API projects in the navigation.

3. Click Add | Add API project.
4. In the definition tree view, click the topmost node.
5. Click View | Node editor on the menu bar.
6. In the node editor view, configure the following settings.

One Identity Manager 8.1.2 API Designer User and Development Guide
68
API projects
 Setting Description

General settings

Identifier Enter a unique name for the node.

Technical abbreviation Enter a short name for the API project.

This name is used later for the assign-
ment of the project.

Control-ID Enter a unique ID for the node.

Model version Shows the model version being used.

Workflow control

Allow extensions to this document Enable this option to permit the creation
of enhancements to this node.

Advanced settings

Required database modules (Optional) Enter the database modules

required for this API project.

7. Configure further API project settings (see Configuring authentication on page 71 and
Configuring the compilation on page 74).
8. On the toolbar, click Save.

Related topics

l Editing API projects on page 69

l Configuring authentication on page 71
l Configuring the compilation on page 74
l Deleting API projects on page 70
l API projects on page 68
l Navigation on page 21

Editing API projects

You can edit any API projects you have created at any time.
NOTE: You cannot edit any API projects that have been predefined by the API Designer.

To edit an API project

1. On the menu bar, click View | Navigation.

2. Click

One Identity Manager 8.1.2 API Designer User and Development Guide
69
API projects
 API projects in the navigation.
3. In the tree structure, double-click the API project to be edited.
4. Click View | Node editor on the menu bar.
5. Use the Definition tree view and the Node editor view to configure further API project
settings (see Configuring authentication on page 71 and Configuring the compilation
on page 74).
6. On the toolbar, click Save.

Related topics

l Creating API projects on page 68

l Configuring authentication on page 71
l Configuring the compilation on page 74
l Deleting API projects on page 70
l API projects on page 68
l Navigation on page 21

Deleting API projects

You can delete any API projects you have created at any time.
NOTE: You cannot delete any API projects that have been predefined by the API
Designer.

To delete an API project

1. On the menu bar, click View | Navigation.

2. Click API projects in the navigation.

3. In the tree structure, click on the API project to be deleted.
4. Click Delete.
5. Confirm the prompt by selecting Yes in the dialog.
6. Click Reload data in the tree structure.

Related topics

l Creating API projects on page 68

l Editing API projects on page 69
l API projects on page 68
l Navigation on page 21

One Identity Manager 8.1.2 API Designer User and Development Guide
70
API projects
Configuring authentication
The Authentication node in the definition tree view is used to determine how clients will
log in to the API.
There are three authentication options that you can configure:

l Standard: Only the authentication methods you list here are permitted. For this
method you can also enable single sign-on.
l Allow all manual modules: All manual authentication modules are permitted, if
these are activated for the selected product. For this method you can also enable
single sign-on.
l Fixed credentials: This settings enables the user to log in to the API using fixed login
data. To use this option, the login data must be stored in the [Link] files on each
API server.

To set the permitted manual authentication options

1. On the menu bar, click View | Navigation.

2. Click API projects in the navigation.

3. In the tree structure, double-click the API project to be edited.
4. In the definition tree view, click the Authentication node.
5. Click View | Node editor on the menu bar.
6. In the node editor view, perform the following actions:
a. In the Authentication type menu, select Standard.
b. Enter a unique ID for the node in the Control ID field.
c. (Optional) In the Authentication properties field, enter the properties for
the authentication. For more information about the authentication modules,
see the One Identity Manager Configuration Guide.
d. (Optional) If authorizations for users are controlled by a product, enable the
Product option and select the required product in the selection list.
7. In the definition tree view, open the Authentication node.
8. Right-click the Manual authentication modules node.
9. Click Authentication module in the context menu.
The Authentication module node is placed as a child to the node.
10. Click the Authentication module node.
11. In the node editing view, select the required authentication module from the Name
selection list. For more information about the authentication modules, see the One
Identity Manager Configuration Guide.
12. Enter a unique ID for the node in the Control ID field.

One Identity Manager 8.1.2 API Designer User and Development Guide
71
API projects
 13. Repeat steps 8 to 12 until to add each authentication method you wish to use.
14. Click Save on the menu bar.

To permit all manual authentication options

1. On the menu bar, click View | Navigation.

2. Click API projects in the navigation.

3. In the tree structure, double-click the API project to be edited.
4. In the definition tree view, click the Authentication node.
5. Click View | Node editor on the menu bar.
6. In the node editor view, perform the following actions:
a. In the Authentication type selection list, select Allow all manual
modules.
b. Enter a unique ID for the node in the Control ID field.
c. (Optional) In the Authentication properties field, enter the authentication
properties.
d. (Optional) Enable the Product option and select the product from the list.
7. Click Save on the menu bar.

To allow single sign-on

1. On the menu bar, click View | Navigation.

2. Click API projects in the navigation.

3. In the tree structure, double-click the API project to be edited.
4. In the definition tree view, open the Authentication node.
5. Right-click the Authentication modules for single sign-on node.
NOTE: This node is only available if you have manually set the authentication
options yourself or if you have enabled all manual authentication options.
6. Click Authentication module in the context menu.
The Authentication module node is placed as a child to the node.
7. Click the Authentication module node.
8. Click View | Node editor on the menu bar.
9. In the node editing view, select the required authentication module from the Name
selection list. For more information about the authentication modules, see the One
Identity Manager Configuration Guide.
10. Click Save on the menu bar.

Log in with stored login data

To approve a login with stored login data, perform the following two steps:

One Identity Manager 8.1.2 API Designer User and Development Guide
72
API projects
 1. Store the login data for the users for whom you want to allow access in the
[Link] file of each API server.
2. Configure the authentication in the API Designer for the API project.

To store login data in the API Server

1. Connect to your API Server.

2. Open the [Link] file in a text editor.
NOTE: If the file is encrypted, you must decrypt it before editing.
3. In the <connectionStrings> section, add the following entry:

<add name="sub:<NAME>" connectionString="Module=DialogUser;User=<USER>;

(Password)Password=<PASSWORD>" />

l <NAME> stands for the name/ID of the API project.

l <USER> stands for the login name of the user.
l <PASSWORD> stands for the user's password.
4. Save your changes to the file.
5. (Optional) encrypt the file.

To configure the login with the saved login data on the API project

1. Start the API Designer.

2. On the menu bar, click View | Navigation.

3. Click API projects in the navigation.

4. In the tree structure, double-click the API project to be edited.
5. In the definition tree view, click the Authentication node.
6. Click View | Node editor on the menu bar.
7. In the node editor view, perform the following actions:
a. In the Authentication type selection list, select Fixed credentials.
b. Enter a unique ID for the node in the Control ID field.
c. (Optional) In the Authentication properties field, enter the authentication
properties.
d. (Optional) Enable the Product option and select the product from the list.
8. Click Save on the menu bar.

Related topics

l Creating API projects on page 68

l Editing API projects on page 69
l API projects on page 68

One Identity Manager 8.1.2 API Designer User and Development Guide
73
API projects
Configuring the compilation
Use the Compilation settings node in the definition tree view to configure the settings for
compiling the API.
If you want to use code from other DLLs in your API code (for example, API files from
other projects), you need to create an assembly reference so that the compiler
recognizes these DLLs.

To create an assembly reference

1. On the menu bar, click View | Navigation.

2. Click API projects in the navigation.

3. In the tree structure, double-click the API project to be edited.
4. In the definition tree view, right-click the Compilation settings node.
5. In the context menu, click Assembly reference.
The Assembly reference node is added under this node.
6. In the definition tree view, click Assembly reference.
7. Click View | Node editor on the menu bar.
8. In the node editor view, enter the name of the assembly you wish to reference into
the Referenced assembly field.
9. Click Save on the toolbar.

Related topics

l Compiling an API on page 57

l Creating API projects on page 68
l Editing API projects on page 69
l API projects on page 68
l Configuring authentication on page 71

Assigning API files to an API project

In order for the API files you have created to be used practically, they must be assigned to
an API project.

To assign API files to an API project

1. On the menu bar, click View | Navigation.

2. In the navigation view, click

One Identity Manager 8.1.2 API Designer User and Development Guide
74
API projects
 API projects.
3. In the tree structure, double-click the API project to be edited.
4. In the definition tree view, right-click the topmost node.
5. In the context menu, click API file reference.
The new API file reference node is added.
6. In the definition tree view, click API file reference.
7. Click View | Node editor on the menu bar.
8. In the node editor view, enter a unique ID for the node into the Control ID field.
9. Select the required file in the Name list.

TIP: To skip directly to the file definition, click Show definition object.
10. On the toolbar, click Save.

Related topics

l Creating API files on page 77

l Editing API files on page 77
l Importing API files on page 79
l Deleting API files on page 78
l Creating API projects on page 68
l Editing API projects on page 69
l Deleting API projects on page 70
l API projects on page 68

Importing API projects

You can import API projects into the API Designer. The API Designer independently detects
whether the projects are API projects, and imports them as such.

To import an API project

1. Click Edit | Import object on the menu bar.

2. In the file browser, select the required API project and click Open.
The API project is imported.

Related topics

l API projects on page 68

l Menu bar on page 16

One Identity Manager 8.1.2 API Designer User and Development Guide
75
API projects
 7

API files

You can use an API file to create a call for exchanging data with the server (or database)
relating to a specific application scenario. An API file can belong to more than one project.
In an API file, you can define an API method, for example.
NOTE: If you create a new API file to provide a new API method, you must name the API
file the same as the class. Ensure you use the correct case.
You can use the API Designer to create the following API files.

Entity files

Entity files 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 file, 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 files, see the SDK under Sdk01_Basics\01-
[Link].

C# files

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

SQL files

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

One Identity Manager 8.1.2 API Designer User and Development Guide
76
API files
Related topics

l Creating API files on page 77

l Editing API files on page 77
l Deleting API files on page 78
l Assigning API files to an API project on page 78
l Importing API files on page 79

Creating API files

You can create new API files at any time.
NOTE: If you create a new API file to provide a new API method, you must name the API
file the same as the class. Ensure you use the correct case.

To create an API file

1. On the menu bar, click View | Navigation.

2. In the navigation, click API files.

3. Click Add | Add API file.
4. In the new window, create the file definition.
5. On the toolbar, click Save.

Related topics

l API files on page 76

l Editing API files on page 77
l Deleting API files on page 78
l Navigation on page 21

Editing API files

You can edit the API files you have created at any time.
NOTE: You cannot edit API files that have been predefined by the API Designer.

To edit an API file

1. On the menu bar, click View | Navigation.

2. In the navigation, click API files.

One Identity Manager 8.1.2 API Designer User and Development Guide
77
API files
 3. In the tree structure, click the API file that you want to edit.
4. In the new window, create the file definition.
5. On the toolbar, click Save.

Related topics

l API files on page 76

l Creating API files on page 77
l Deleting API files on page 78
l Navigation on page 21

Deleting API files

You can delete the API files you have created at any time.
NOTE: You cannot delete API files that have been predefined by API Designer.

To delete an API file

1. On the menu bar, click View | Navigation.

2. In the navigation, click API files.

3. In the tree structure, click the API file that you want to delete.
4. Click Delete.
5. Confirm the prompt by selecting Yes in the dialog.
6. Click Reload data in the tree structure.

Related topics

l API files on page 76

l Creating API files on page 77
l Editing API files on page 77
l Navigation on page 21

Assigning API files to an API project

In order for the API files you have created to be used practically, they must be assigned to
an API project.

One Identity Manager 8.1.2 API Designer User and Development Guide
78
API files
To assign API files to an API project

1. On the menu bar, click View | Navigation.

2. In the navigation view, click API projects.

3. In the tree structure, double-click the API project to be edited.
4. In the definition tree view, right-click the topmost node.
5. In the context menu, click API file reference.
The new API file reference node is added.
6. In the definition tree view, click API file reference.
7. Click View | Node editor on the menu bar.
8. In the node editor view, enter a unique ID for the node into the Control ID field.
9. Select the required file in the Name list.

TIP: To skip directly to the file definition, click Show definition object.
10. On the toolbar, click Save.

Related topics

l Creating API files on page 77

l Editing API files on page 77
l Importing API files on page 79
l Deleting API files on page 78
l Creating API projects on page 68
l Editing API projects on page 69
l Deleting API projects on page 70
l API projects on page 68

Importing API files

You can import API files into the API Designer. The API Designer automatically detects that
the files are API files and imports them as such.

To import an API file

1. Click Edit | Import object on the menu bar.

2. In the file browser, select the API file and click Open.
The API file is imported.

One Identity Manager 8.1.2 API Designer User and Development Guide
79
API files
Related topics

l API files on page 76

l Menu bar on page 16

One Identity Manager 8.1.2 API Designer User and Development Guide
80
API files
 8

API Server

The API that you created in the API Designer is available in the API Server.

To call the API Server web interface

l In a web browser, open the web address (URL) of your API Server.
From here, you can:
l Configure the API Server.
l Call the swagger documentation for your API.
l Open the Operations Support Web Portal.
l Call all installed HTML5 applications.

One Identity Manager 8.1.2 API Designer User and Development Guide
81
API Server
 9

ImxClient command line program

The ImxClient command line tool can be used to execute all API Designer API functions
from a command line without a graphical interface.

Related topics

l Starting the ImxClient command line program on page 82

l ImxClient command overview on page 82

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 installation path for the API Designer.
3. Run the [Link] application.

Related topics

l ImxClient command line program on page 82

ImxClient command overview

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

One Identity Manager 8.1.2 API Designer User and Development Guide
82
ImxClient command line program
Related topics

l help on page 83
l compile-app on page 83
l repl on page 84
l branch on page 84
l connect on page 85
l compile-api on page 85
l fetch-files on page 87
l push-files on page 87
l get-apistate on page 88
l get-filestate on page 88
l setup-web on page 89
l run-apiserver on page 90
l check-translations on page 91

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

Related topics

l ImxClient command line program on page 82

l ImxClient command overview on page 82

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

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

2. Executes 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.

One Identity Manager 8.1.2 API Designer User and Development Guide
83
ImxClient command line program
Parameters

l /conn <name of the database connection>: Specify the database to which you
want to connect.
l /dialog <name of the dialog authentication>: Enter the dialog authentication.
l /path <path to main folder>: Enter the path to the main folder. This folder contains
the application to be compiled. This folder normally contains the [Link] file of
the application.
l -N: (Optional) Prevents saving to the database.
l -D: Executes debug compilation.
l /branch <ID of the compilation branch>: (Optional) Saves the compiled result under
the specified compilation branch. You must also specify the parameter -D.

Related topics

l ImxClient command line program on page 82

l ImxClient command overview on page 82

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 plug-in.
l Output the results of processing to stdout.

Related topics

l ImxClient command line program on page 82

l ImxClient command overview on page 82

branch
Manages compilation branches in the database.

Parameters

l Run without parameters: If the command is called without specifying any

parameters, this command outputs the total number of compilation branches and

One Identity Manager 8.1.2 API Designer User and Development Guide
84
ImxClient command line program
 their IDs from the database.
l /id <ID of the compilation branch>: (Optional) Queries the field name and
corresponding values of a compilation branch.
l -d /id <ID of the compilation branch>: (Optional) Deletes a compilation branch.
l branch -c /id <ID of the compilation branch>: (Optional) Creates a new
compilation branch.
To also specify a description of the compilation branch, use /description
<description>.

Related topics

l ImxClient command line program on page 82

l ImxClient command overview on page 82

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

l /conn <name of the database connection>: Specify the database to which you
want to connect.
l /dialog <name of the dialog authentication>: Enter the dialog authentication.
l /factory <target system>: (Optional) Enter the target system for the connection.
Enter this parameter if you want to establish a connection to the application server.

Related topics

l ImxClient command line program on page 82

l ImxClient command overview on page 82

compile-api
Compiles the API and saves the result to the database.

One Identity Manager 8.1.2 API Designer User and Development Guide
85
ImxClient command line program
Parameters

l /conn <name of the database connection>: Specify the database to which you
want to connect.
l /dialog <name of the dialog authentication>: Enter the dialog authentication.
l /factory <name of target system>: (Optional) Enter the target system for the
connection. Enter this parameter if you want to establish a connection to the
application server. Example: [Link].
l /solution <path to solution project>: (Optional) Enter the path to the solution
project file that you want to use. If you do not enter these parameters, a database
project is used.
l /mode <compile mode>: (optional) Enter the mode for the compilation:
l normal: Complete compilation (default mode).
l nostore: Assemblies are not saved in the database.
l nocompile: Creates only C# code. The compilation is not executed.
l nocodegen: Executes only the compilation. No C# code is generated.
l -E: (Optional) Activates extended checks.
l -D: (Optional) The compilation is executed as debug compilation.
l /csharpout <path to target folder for C# files>: (Optional) Enter the path to the
folder in which you want to save the C# files.
l /copyapi <path to folder>: (Optional) Enter the path to the folder to which you want
to copy the [Link] file.
l /apidll <path to an API-DLL>: (Optional) Enter the path for an API-DLL file that
you want to use. The /solution and /branch parameters are ignored if you use
this parameter.
l /branch <ID of the compilation branch>: (Optional) Enter the compilation branch
under which you want to save the project. You must also specify the parameter -D.
l /nowarn <error1,error2,...>: (Optional) Specify which errors are to be ignored
during compilation. Enter the codes for the warnings, separated by commas.
l /warnaserror <error1,error2,...>: (Optional) Specify which warnings are
displayed as errors during compilation. Enter the codes for the warnings,
separated by commas.

Related topics

l ImxClient command line program on page 82

l ImxClient command overview on page 82

One Identity Manager 8.1.2 API Designer User and Development Guide
86
ImxClient command line program
fetch-files
Loads all files of the HTML Development machine role from the database and saves them in
a local file.

Parameters

l /conn <name of the database connection>: Specify the database to which you
want to connect.
l /dialog <name of the dialog authentication>: Enter the dialog authentication.
l /factory <target system>: (Optional) Enter the target system for the connection.
Enter this parameter if you want to establish a connection to the application server.
l /path <path to target folder>: (Optional) Enter the path to the folder in which you
want to save the files.
l /targets <target1;target2;...>: (Optional) Specify which machine roles you want to
use. If you do not use this parameter, the HTML Development machine role is used.

Related topics

l ImxClient command line program on page 82

l ImxClient command overview on page 82

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

Parameters

l /conn <name of the database connection>: Specify the database to which you
want to connect.
l /dialog <name of the dialog authentication>: Enter the dialog authentication.
l /targets <target1;target2;...>: Specify which machine roles you want to use. If you
do not use this parameter, the HTML Development machine role is used.
l /factory <target system>: (Optional) Enter the target system for the connection.
Enter this parameter if you want to establish a connection to the application server.
l /path <path to folder>: (optional) Enter the path to the folder containing the files
that you have changed and you now want to save to the database.
l /tag <uid>: (Optional) Specifies the UID of a change tag.
l /add <file1;file2;...>: (Optional) Specify the paths to all new files to be added to
the database. Use relative paths.

One Identity Manager 8.1.2 API Designer User and Development Guide
87
ImxClient command line program
 l /del <file1;file2;...>: (Optional) Enter the paths to all files that you want to delete
from the database. Use relative paths.
l -C: (Optional) Prevents the saving of changed files and saves only new files, and
deletes files from the database.

Related topics

l ImxClient command line program on page 82

l ImxClient command overview on page 82

get-apistate
Queries the compilation status of the API in the database.

Parameters

l /conn <name of the database connection>: Specify the database to which you
want to connect.
l /dialog <name of the dialog authentication>: Enter the dialog authentication.
l /factory <target system>: (Optional) Enter the target system for the connection.
Enter this parameter if you want to establish a connection to the application server.
l /branch <ID of the compilation branch>: (Optional) Queries the date of the
compilation status of the API under which this compilation branch was saved.
l /htmlapp <name of the HTML package>: (Optional) Supplies data for the specified
HTML package.
l -D: (Optional) Supplies data for debug assemblies.
l -R: (Optional) Supplies data for release assemblies.

Related topics

l ImxClient command line program on page 82

l ImxClient command overview on page 82

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.

One Identity Manager 8.1.2 API Designer User and Development Guide
88
ImxClient command line program
You can adjust this parameter in the Designer. Use the following formats when
defining the rules:
[Link]
us/dotnet/api/[Link]
Use the | character to separate 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

l /conn <name of the database connection>: Specify the database to which you
want to connect.
l /dialog <name of the dialog authentication>: Enter the dialog authentication.
l /factory <target system>: (Optional) Enter the target system for the connection.
Enter this parameter if you want to establish a connection to the application server.
l /targets <target1;target2;...>: (Optional) Specify which machine roles you want to
use. If you do not use this parameter, the HTML Development machine role is used.
l /path <path to folder>: (Optional) Enter the path to the folder containing the files
that you want to synchronize.

Related topics

l ImxClient command line program on page 82

l ImxClient command overview on page 82

setup-web
Installs necessary files for the development of TypeScript clients.

Parameters

l /root: Enter the path to the main folder.

l /conn <name of the database connection>: Specify the database to which you
want to connect.
l /dialog <name of the dialog authentication>: Enter the dialog authentication.
l /factory <target system>: (Optional) Enter the target system for the connection.
Enter this parameter if you want to establish a connection to the application server.
l /path <path to the API project>: (Optional) Specify the path to the folder for the
API project.
l /branch <ID of the compilation branch>: (Optional) Enter the ID of a compilation
branch for which you want to install files.

One Identity Manager 8.1.2 API Designer User and Development Guide
89
ImxClient command line program
Related topics

l ImxClient command line program on page 82

l ImxClient command overview on page 82

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

Parameters

l /conn <name of the database connection>: Specify the database to which you
want to connect.
l /dialog <name of the dialog authentication>: Enter the dialog authentication.
l /factory <target system>: (Optional) Enter the target system for the connection.
Enter this parameter if you want to establish a connection to the application server.
l -S: (Optional) Stops the API Server.
l /baseaddress <URL with port>: (Optional) Specify the base URL and the port of the
HTML application.
l /baseurl <base URL>: (Optional) Enter the base URL of the HTML application.
l /branch <ID of the compilation branch>: (Optional) Specify the ID of a compilation
branch for whose API you want to start the API Server.
l -D: (Optional) Loads the debugging assemblies.
l -C: (Optional) Compiles the API using source data from the database.
l -T: (Optional) Retrieves the status of the currently running API Server.
l -B: (Optional) Locks the console.
l /compile {path to solution file}: Compiles the API using source data from a (local)
solution project.
l /excludedMiddlewares {Middleware-Name1,Middleware-Name2,...}: (Optional) Specify
which middleware services you do not want to offer. Enter multiple values separated
by a comma.

Related topics

l ImxClient command line program on page 82

l ImxClient command overview on page 82

One Identity Manager 8.1.2 API Designer User and Development Guide
90
ImxClient command line program
check-translations
Search for captions (multilingual captions) with missing translations in a particular folder
and its subfolders.

Parameters

l /conn <name of the database connection>: Specify the database to which you
want to connect.
l /dialog <name of the dialog authentication>: Enter the dialog authentication.
l /path <Path to folder>: Enter the path to the folder that you want to check.
l /factory <target system>: (Optional) Enter the target system for the connection.
Enter this parameter if you want to establish a connection to the application server.

Related topics

l ImxClient command line program on page 82

l ImxClient command overview on page 82

One Identity Manager 8.1.2 API Designer User and Development Guide
91
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 8.1.2 API Designer User and Development Guide
92
About us
 Index
I ndex

A API Server 81

add assembly reference 74

API files 77 authentication

API projects 68 configure 71

change label 38
compiler branch 63 B
database query 49-50
basics 8
multilingual captions 45
benefits 7
API
bookmarks 55
test 64
delete 57
API Designer 7
display 55
start 11
open 55
API development
place 56
basics 8
remove 57
API files 76
branches 62
add 77
assign to a project 74, 78
C
change 77
create 77 C Sharp methods 76

delete 78 C# project 65

edit 77 captions 44

import 79 change 46

remove 78 create 45

API projects 68 delete 47

add 68 edit 46

change 69 find 45

create 68 new 45

delete 70 remove 47

edit 69 search 45

import 75 change

remove 70 API methods 77

One Identity Manager 8.1.2 API Designer User and Development Guide
93
Index
 API projects 69 create 63
captions 46 delete 64
change label 39 edit 63
compiler branch 63 new 63
database query 50 remove 64
global settings 26 select 62
multilingual captions 46 compiling 57
nodes 37 configure 74
settings 26 display 61
change label 37 execute 59
add 38 open 61
apply 38 start 59
change 39 test 58
create 38 configurations
delete 40 authentication 71
edit 39 compiling 74
new 38 context menu 32
remove 40 create
CLI 82 API files 77
close API projects 68
tab 52 captions 45
code change label 38
display 34 compiler branch 63
colors 20 database query 49-50
command line 82 multilingual captions 45
command list 54 custom layout 53
display 54
open 54 D
commandos 82
database project 12
commands 54
database query 48
compile 57, 59
add 49-50
compiler branch 62
change 50
add 63
create 49-50
apply 62
delete 52
change 63
edit 50

One Identity Manager 8.1.2 API Designer User and Development Guide
94
Index
 manage 48 E
new 49-50
edit
remove 52
API files 77
test 51
API projects 69
deactivate compilation 29
captions 46
debug 57
change label 39
default layout 53
compiler branch 63
restore 53
database query 50
definition tree
multilingual captions 46
open 31
nodes 37
definition tree view 27, 30-31
editing nodes 35
open 31
entity methods 76
delete
examples 9
API methods 78
execute
API projects 70
compiling 59
bookmarks 57
export 12, 14
captions 47
export solution 14
change label 40
extensions 34
compiler branch 64
database query 52
F
multilingual captions 47
display file based 13

bookmarks 55 file path 29

code 34 find

command list 54 captions 45

compiling 61 multilingual captions 45

definition tree 31 find and replace 40, 43

definition tree view 31 fix error 61

definitions 31 fix warnings 61

generated code 34
navigation 22 G
object properties 28 generated code 34
task window 61 global settings 23
change 26

One Identity Manager 8.1.2 API Designer User and Development Guide
95
Index
 open 26 L
graphical user interface 15
language 44-47
GUI 15
languages 44-47
layout 53
H restore 53

help 9 save 53

I M

icons 19 managing database queries 48

import menu 16

API files 79 menu bar 16

API projects 75 multilingual captions 44-47

import namespace 74 add 45

import object to database 14 change 46

ImxClient 82 create 45

commandos 82 delete 47

branch 84 edit 46

check-translations 91 find 45

compile api 85 new 45

compile app 83 remove 47

connect 85 search 45

fetch-files 87
get-apistate 88 N
get-filestate 88
namespace 74
help 83
navigate 21
push-files 87
navigation 21
repl 84
display 22
run-apiserver 90
open 22
setup-web 89
new
ImxClient command line program
API files 77
start 82
API projects 68
interface 15
captions 45
change label 38

One Identity Manager 8.1.2 API Designer User and Development Guide
96
Index
 compiler branch 63 P
database query 49-50
postman 81
multilingual captions 45
project types 12
new API file 77
new API project 68
Q
node editor 35
open 36 quick start 10

node editor view 35

nodes R
change 37 redo 23, 54
edit 37 release 57
reload object 29
O remove

object properties 27 API files 78

display 28 bookmarks 57

open 28 captions 47

open change label 40

bookmarks 55 compiler branch 64

command list 54 database query 52

compiling 61 multilingual captions 47

definition tree 31 repeat 23

definition tree view 31 replace 40, 43

generated code 34 resolution 23

global settings 26 right click 32

home page 23 run

navigation 22 command line program 82

node editor 36 compiling 59

object properties 28
settings 26 S
solution 30 save
tab 52 tab 52
task window 61 save changes 14
option 23 save locally 12

One Identity Manager 8.1.2 API Designer User and Development Guide
97
Index
save to disk 12 task window 60
save type display 61
specify 12 open 61
SDK 9 tasks 60
search 40, 43 test
captions 45 API 64
multilingual captions 45 compiling 58
searching 40, 43 database query 51
settings 23 SQL expression 51
change 26 text 44-47
open 26 toolbar 19
single sign-on 71 type member 74
software development kit 9
solution 29 U
open 30
UI 15
solution project 12-13
undo 23, 54
specify
usage
save type 12
change label 38
SQL expression
user interface 15
test 51
SQL files 76
SSO 71 V
start 11 version control 62
start page 23 Visual Studio 65
open 23
status bar 20
meaning of the colors 20
Swagger 81

T
tab 52
close 52
manage 52
open 52
save 52

One Identity Manager 8.1.2 API Designer User and Development Guide
98
Index