Chat now with support
Chat with Support

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

Creating API projects

You can create new API projects at any time.

To create an API project

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

    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 assignment 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 and Configuring the compilation).

  8. On the toolbar, click (Save).

Related topics

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. In 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. 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 and Configuring the compilation).

  6. On the toolbar, click (Save).

Related topics

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. In 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 with Yes in the dialog.

  6. Click (Reload data) in the tree structure.

Related topics

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:

  • Standard: Only the authentication methods you list here are permitted. For this method you can also enable single sign-on.

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

  • 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 web.config files on each API server.

To set the permitted manual authentication options

  1. In 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 node (Authentication).

  5. Click View > Node editor on the menu bar.

  6. In the node editor view, perform the following actions:

    1. In the Authentication type menu, select Standard.

    2. Enter a unique ID for the node in the Control ID field.

    3. (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.

    4. (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, expand the node (Authentication).

  8. Right-click the node (Manual authentication modules.

  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.

  13. Repeat steps 8 to 12 until to add each authentication method you wish to use.

  14. On the menu bar, click (Save).

To permit all manual authentication options

  1. In the menu bar, click View > Navigation.

  2. In the navigation, click (API projects).

  3. In the tree structure, double-click the API project to be edited.

  4. In the Definition tree view, click the node (Authentication).

  5. Click View > Node editor on the menu bar.

  6. In the node editor view, perform the following actions:

    1. In the Authentication type selection list, select Allow all manual modules.

    2. Enter a unique ID for the node in the Control ID field.

    3. (Optional) In the Authentication properties field, enter the authentication properties.

    4. (Optional) Enable the Product option and select the product from the list.

  7. On the menu bar, click (Save).

To allow single sign-on

  1. In the menu bar, click View > Navigation.

  2. In the navigation, click (API projects).

  3. In the tree structure, double-click the API project to be edited.

  4. In the definition tree view, expand the node (Authentication).

  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. On the menu bar, click (Save).

Log in with stored login data

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

  1. Store the login data for the users for whom you want to allow access in the web.config 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 web.config 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>" />

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

    • <USER> stands for the login name of the user.

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

  3. In the navigation, click (API projects).

  4. In the tree structure, double-click the API project to be edited.

  5. In the Definition tree view, click the node (Authentication).

  6. Click View > Node editor on the menu bar.

  7. In the node editor view, perform the following actions:

    1. In the Authentication type selection list, select Fixed credentials.

    2. Enter a unique ID for the node in the Control ID field.

    3. (Optional) In the Authentication properties field, enter the authentication properties.

    4. (Optional) Enable the Product option and select the product from the list.

  8. On the menu bar, click (Save).

Related topics
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating