Chat now with support

Get Live Help
Complete Registration

Sign In

Request Pricing

Contact Sales

Identity Manager 8.1.4 - API Designer User and Development Guide

Table of Contents

API Designer Basic principles of API development

Guidelines and conventions

Handling of API Server queries Authentication

Authentication (primary) Authentication with Starling 2FA (secondary) Logging out

Session status and security tokens

Querying session status

HTTP methods Date formats Parameter formats

URL parameters Query parameters

Response formats Response codes General notes and information about entity methods Avoiding deadlocks

Examples and help – Software Development Kit Quick start – Creating an API Working with the API Designer

Starting the API Designer Project types

Changing the project type Solution projects

Importing solution project changes into a database

Menu bar Toolbar Status bar Navigation

Opening the navigation

Opening the start page

Global settings

Changing global settings Switching languages

Database objects

Object properties

Displaying object properties

Managing objects in a project (solution)

Opening the solution

Editing database objects (definition tree view)

Opening the definition tree view Context menu in the definition tree window Extensions Viewing and saving generated code belonging to a node Node editor view

Opening the node editor view Editing nodes

Labeling changes

Using change labels Creating a change label Change management Deleting change labels

Find and replace

Running a search

Multilingual captions

Creating multilingual captions Searching for a multilingual caption Editing a multilingual caption Deleting a multilingual caption

Managing database queries

Displaying database queries Creating a database query Editing a database query Testing a database query Deleting a database query

Managing tabs Managing layouts Displaying the change history (command list)

Opening the command list

Editing bookmarks Setting bookmarks Deleting bookmarks

Compiling an API

Testing a compilation Starting a compilation Managing compilation errors and warnings (task window)

Opening the task window Resolving errors and warnings

Opening the compiling log

Managing versions (compilation branches)

Selecting and using compilation branches Creating compilation branches Editing compilation branches Deleting compilation branches

Testing an API Linking C# projects to the API Designer

Creating API projects Editing API projects Deleting API projects Configuring authentication Configuring the compilation Assigning API files to an API project Importing API projects

Creating API files Editing API files Deleting API files Assigning API files to an API project Importing API files

API Server ImxClient command line program

Starting the ImxClient command line program ImxClient command overview

help compile-app repl branch connect compile-api install-apiserver fetch-files push-files get-apistate get-filestate setup-web run-apiserver check-translations version

Opening the command list

Working with the API Designer > Displaying the change history (command list) > Opening the command list

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

To open the command list

Click on View | Command list on the menu bar.

Related topics

Displaying the change history (command list)

Bookmarks

Working with the API Designer > Bookmarks

Open the Bookmarks window using View | Bookmarks (see Editing bookmarks).

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 bookmarks	Deletes all bookmarks (see Deleting bookmarks).
Edit bookmark description	Opens a dialog that allows you to change the description of the selected bookmark (see Editing bookmarks).
Remove module/component bookmark	Deletes all bookmarks for the module (or component) selected in the list (see Deleting bookmarks). 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 bookmark	Deletes the bookmark that you have selected in the list (see Deleting bookmarks).
Group by modules/components	Groups the bookmarks by the API projects to which they are assigned.

Related topics

Editing bookmarks

Working with the API Designer > Bookmarks > Editing bookmarks

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

To open the bookmark window

Click View | Bookmarks on the menu bar.

To open a bookmark

Click View | Bookmarks on the menu bar.
Double-click a bookmark in the Bookmarks window.

To edit the bookmark description

Click View | Bookmarks on the menu bar.
Click a bookmark in the Bookmarks window.
Click Edit bookmark description.
Insert a description for the bookmark in the Bookmark description dialog.
Click OK.

Related topics

Setting bookmarks

Working with the API Designer > Bookmarks > 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

On the menu bar, click View | Navigation.
In the navigation, double-click the database object that contains the node you require.
In the definition tree view, right-click the node for which you would like to set a bookmark.
Click Set bookmark in the context menu.
Insert a description for the bookmark in the Bookmark description dialog.
Click OK.

Related topics

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating

© 2024 One Identity LLC. ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center