지금 지원 담당자와 채팅
지원 담당자와 채팅

Identity Manager 8.2 - API Designer User and Development Guide

API Designer Basic principles of API development Examples and help – Software Development Kit Quick start – Creating an API Working with the API Designer
Starting the API Designer Project types User interface Global settings Database objects Labeling changes Find and replace Multilingual captions Managing database queries Managing tabs Managing layouts Displaying the change history (command list) Bookmarks Compiling an API Managing versions (compilation branches) Testing an API Linking C# projects to the API Designer
API projects API methods API Server ImxClient command line program

Quick start – Creating an API

The following provides a general 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 or edit an existing one (for example, supplied by One Identity) to take advantage of the features already available and customize it to your own needs.

  4. Configure the authentication for the API project (Single Sign-On, for example).

    NOTE: If you edit an existing API project supplied by One Identity, you will no longer be able to change the authentication.

  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

Working with the API Designer

This section provides you with general information on working with the API Designer.

For example, you will learn:

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 ApiDesigner.Editor.exe application.

    The API Designer opens.

  3. Perform one of the following tasks:

    • To use an existing connection to the One Identity Manager database, select it in the Select a database connection menu.

    • 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:

    • Click Database project to save the project in the database.

    • Click Solution project to save the project within a solution.

      TIP: For more information, see Project types.

  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

Project types

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

  • Database project: The project will be stored in the database. Your saved changes are visible to others.

  • Solution project: API Designer allows file-based editing of custom objects locally on your own computer. For more information, see Solution projects.

Related topics
관련 문서

The document was helpful.

평가 결과 선택

I easily found the information I needed.

평가 결과 선택