The Client Credentials page lets you create and manage the client credentials used to obtain API access tokens. Client credentials provide a secure and structured way to authenticate API access.
Overview
A maximum of ten client credential objects can be created in one operation. Each client credential can have a maximum of 10 access tokens, so a maximum of 100 access tokens can be present in one operation at a time.
When a client credential is deleted, the related access tokens become invalid.
Editing or deleting a client credential
You can edit or delete a client credential object. If a client credential is deleted, its related access tokens become invalid.
Creating a new client credential
When you create a new client credential, fill in the attributes described below and save the client credential.
Field descriptions
The client credential object has the following attributes:
Field | Description |
Name | Any given name to identify the client credential object. |
Description | Brief information about the client credential's purpose. |
Added API | Allows you to define APIs individually for each client credential. In this field, you can add, edit and remove specific APIs, which lets you define customized API access permissions for each client credential. |
Allowed IPs | The IP addresses and/or IP address blocks that the client credential is bound to. Any attempt from another IP address will not be successful. |
API List | Lets you view the existing API list and add or remove APIs collectively. From the Add API section you can add specific APIs, and with the Unselect All option you can clear all selected APIs. This lets you manage API access permissions for each client credential. |
Client ID and Client Secret
After saving the client credential, you can access the Client ID and Client Secret information.
Important: The Client ID and Client Secret are shown only once for security purposes, so make a note of these values before moving on to the next step.
Note: The access tokens refresh themselves hourly, so it is essential to set up a structure that fetches the new access token information accordingly.