Chat now with support
Chat mit Support

Identity Manager 8.2.1 - API Development Guide

Basic principles of API development Examples and help – Software Development Kit API configuration Implementing your own APIs API Designer Quick start – Creating an API with the API Designer 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 ImxClient command line program

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

Changing the project type

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

To save the project as a database project

  1. In 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, enable the option Use selected project as default.

    TIP: To undo this setting:

    1. In the menu bar, click Connection > Settings.

    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. In 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:

    • Click Create solution and use the wizard to create a new solution.

    • Click Load solution and enter the path to an existing solution.

    • 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. In the menu bar, click Connection > Settings.

    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

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).

To import the changes made to the solution project back into the database, follow the instructions in Importing solution project changes into a database.

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:

  • API projects

  • API files

Related topics
Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen