API Clients

An API client is a logical group of users who belong to the same organization.

For each of the environments for development, testing, and production, you can set an API client and link users who can access the API for REST API jobs.

In the API client, set the following items as a strategy against common types of security attacks such as Denial of Service.

Users with access permissions
List of permitted IP addresses

You can configure API clients from > API MANAGEMENT > API Clients in the navigation menu.

The key points about creating and configuring API clients are explained in this section.

Points for settings

This section explains the screen transitions from the API Clients page and the functions such as creating and editing API clients.

= Remarks =

For the names and functions of basic UI elements and other items of HULFT Square, refer to the following topic:

Screen elements

API Clients

In the navigation menu, select > API MANAGEMENT > API Clients to open this page.

You can manage your API clients from here, such as creating, editing, and deleting.

(1) Create API Client

Select this icon to create a new API client.

For details about API client settings, refer to API Clients > Add New.

(2) List of settings

The information about API clients that have already been created is displayed in tabular form.

(3) Action menu

Select this icon to perform operations for API clients that have been created.

Selecting shows the menu of operations below.

Information

Displays detailed information about the selected API client. You can also edit and delete the detailed information about the API client.

When you select this menu item, API Clients > API client name is opened.

Delete

Deletes the selected API client.

API Clients > Add New

On the API Clients page, select Create API Client to open this page.

You can set the information to create an API client by following the wizard-style pages step by step.

Name: Specify the API client name.
Description: Specify the description of the API client.
User allowlist: Specify the users who can access the REST API.
IP allowlist: Specify the IP addresses for which to permit access.
Next: Displays the next page.

API Clients > API client name

On the API Clients page, select Information to open this page.

You can view detailed information about the selected API client.

(1) API client name

In API client name, the name of the API client is displayed.

(2) User allowlist

The users who can access the REST API are displayed.

(3) IP allowlist

The IP addresses for which access is permitted are displayed.

(4) Edit

Modifies and updates the following fields for the API client.

Name
Description
User allowlist
IP allowlist

= Remarks =

If you update an API client, you need to recreate the link between the REST API job and the updated API client.

In this case, disable the REST API job, and then enable it again.

(5) Delete

Deletes the API client.