Chat now with support

Get Live Help
Complete Registration

Sign In

Request Pricing

Contact Sales

Identity Manager 8.2.1 - API Development Guide

Table of Contents

Basic principles of API development

API Server basics

General information about the API Server Calling the API Server web interface Encryption General notes on programming your own API methods

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

Path parameters Query parameters

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

Examples and help – Software Development Kit API configuration

Configuring primary authentication with single sign-on

Configuring authentication for the Operations Support Web Portal

Changing encryption Configuring the compilation

Implementing your own APIs

Creating and editing API plugins

Converting API projects to API plugins

Compiling TypeScript API clients

API Designer Quick start – Creating an API with the API Designer 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 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

ImxClient command line program

Starting the ImxClient command line program ImxClient command overview

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

Basic principles of API development

Basic principles of API development

The main components of an API created using the API Designer are files and projects.

Basics about API files:

Use API files to define API methods for sending data to the application or to querying data from the application.
An API file can belong to more than one project.

Basics about API projects:

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

For basics about the API Server, see API Server basics.

Detailed information about this topic

API Server basics

Basic principles of API development > API Server basics

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

Detailed information about this topic

General information about the API Server

Basic principles of API development > API Server basics > General information about the API Server

The API Server provides the API that you create in the API Designer.
The API Server is implemented using the Owin Platform (see http://owin.org/).
URLs are case sensitive.

Calling the API Server web interface

Basic principles of API development > API Server basics > Calling the API Server web interface

From the API Server's web interface you can:

Configure the API Server.
Call the swagger documentation for your API.
Open the Operations Support Web Portal.
Call all installed web applications.

To call the API Server web interface

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

Self Service Tools: Knowledge Base; Notifications & Alerts; Product Support; Software Downloads; Technical Documentation; User Forums; Video Tutorials; RSS Feed

Contact Us: Licensing Assistance; Technical Support; View All

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