サポートと今すぐチャット
サポートとのチャット

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

API configuration

This section provides you with information about configuring the API.

Detailed information about this topic

Configuring primary authentication with single sign-on

You can configure single sign-on authentication for API projects with the Administration Portal. In this case, a separate request to the imx/login method is not required.

NOTE: You can configure authentication for the Operations Support Web Portal using the appropriate API project (see Configuring authentication for the Operations Support Web Portal).

TO configure primary authentication with single sign-on

  1. In your internet browser, open the your API Server's webpage.

  2. On the overview page, click Administration Portal.

  3. On the login page, select which authentication method you want to use to log in to the Administration Portal.

  4. Enter your user name and password.

  5. Click Connect.

  6. In the navigation, click Configuration.

  7. On the Configuration page, in the Show configuration for the following API project menu, select the API project that you want configure with single sign-on authentication.

  8. In the search box, enter Single sign-on authentication modules.

  9. Expand the Single sign-on authentication modules configuration key.

  10. Click New.

  11. In the menu, select the authentication module you want to use.

    TIP: You can specify additional authentication modules. To do this, click New.

  12. Click Apply.

  13. Perform one of the following actions:

    • If you want to apply the changes locally only, click Apply locally.

    • If you want to apply the changes globally, click Apply globally.

  14. Click Apply.

Detailed information about this topic

Configuring authentication for the Operations Support Web Portal

You can use the Authentication node in the API Designer definition tree view to specify how users can log in to the Operations Support Web Portal.

There are three authentication options that you can configure:

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

  • Allow all manual modules: All manual authentication modules are allowed, provided they are enabled for the selected product. You can also enable single sign-on for this method.

  • Fixed credentials: This setting allows you to log in to the API with stored login credentials. 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. Start the API Designer program.

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

  3. Click API projects in the navigation.

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

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

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

  10. Click Authentication module in the context menu.

    The Authentication module node is placed as a child to the node.

  11. Click the Authentication module node.

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

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

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

  15. In the menu bar, click (Save).

To permit all manual authentication options

  1. Start the API Designer program.

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

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

To allow single sign-on

  1. Start the API Designer program.

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

  6. Right-click the Authentication modules for single sign-on node.

    NOTE: This node is only available if you have manually specified the authentication options yourself or you have permitted manual authentication options.

  7. Click Authentication module in the context menu.

    The Authentication module node is placed as a child to the node.

  8. Click the Authentication module node.

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

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

  11. In 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 credentials of the users with access in each of the API server's web.config file.

  2. Configure authentication in the API Designer's 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.

  3. (Optional) If the file is encrypted, decrypt the file.

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

  5. Save your changes to the file.

  6. (Optional) encrypt the file.

To configure the login with the saved login data on the API project

  1. Start the API Designer program.

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

Related topics

Changing encryption

You can change the encryption used for data by choosing another encryption certificate.

To change the encryption certificate

  1. Connect to your API Server.

  2. Open the web.config file in a text editor.

  3. (Optional) If the file is encrypted, decrypt the file.

  4. Change the value of the certificatethumbprint property to the thumbprint of the certificate you want to use.

  5. Save your changes to the file.

  6. (Optional) encrypt the file.

関連ドキュメント

The document was helpful.

評価を選択

I easily found the information I needed.

評価を選択