After you create an API plugin, you need to compile a corresponding TypeScript API client.
To compile a TypeScript API client
-
Open a command line prompt.
-
Run the following command:
imxclient compile-api -N -W /copyapi imx-api-ccc.tgz /packagename imx-api-ccc
The dialog to select the database connection is opened.
-
In the dialog, perform one of the following actions:
-
to use an existing connection to the One Identity Manager database, select it in the Select a database connection menu.
- OR -
-
to create a new connection to the One Identity Manager database, click Add new connection and enter a new connection.
-
Select the authentication method and, under Authentication method, enter the login data for the database.
-
Click Log in.
-
Import the imx-api-ccc npm package into your TypeScript application.
The API Designer allows you to create, record, compile, and publish a REST API (Representational State Transfer Application Programming Interface) in the quickest way possible. This API is based on the OpenAPI Specification and the One Identity Manager database model.
The main benefits of API Designer include:
-
Offers easy and fast operation.
-
The finished API "understands" the One Identity Manager database model.
-
Modifications to the API are transparent.
-
Supports the principles of good API design.
-
OpenAPI support: APIs that you create using the API Designer are based on the OpenAPI specification standard. This allows you to make use of other tools, including:
- Swagger: Use Swagger to create code, documentation, and test cases.
- Postman: Use Postman to test the various methods of your API.
Quick start – Creating an API with the API Designer
NOTE: One Identity recommends using the API plugin (see Implementing your own APIs) to create and implement APIs rather than the API Designer.
The following provides a general list of the steps you must take to create an API in the API Designer:
-
Start the API Designer.
-
Create API files (in which you can define an API method, for example).
-
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.
-
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.
-
Assign the created API files to the API project.
-
Test the API.
-
Compile the API.
-
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:
