Skip to main content

Access Token

Introduction​

The Access Token menu is used to manage API Keys, authentication tokens that allow users or systems to connect and securely obtain access permissions to the TAKAKRYPT platform.

The following is a guide to managing access token data in the system, including creating new data, viewing the list, filtering, searching, editing, and deleting data.

1. Create New Access Token​

Follow these steps to create a new access token in the system:

1. Open the Access Token menu

  • Open the Access Token menu in the navigation panel.
  • Click the Create New button on the right side of the screen to start creating a new access token.

2. Fill in the form with the following data

  • Token Name: Enter the access token name.
  • Token Description: Add a description of the access token to provide additional detail (optional).

3. Set the API Key Expiration

Choose the API Key expiration option:

  • Never Expired: The API Key does not have an expiration date.
  • Custom Expired: Set the API Key expiration date as needed.

4. Set the Allowed IP Address

Set the IP address restriction for the access token:

  • All: Allows all IP addresses to access the access token.
  • Restricted IP Addresses: Restricts access to specific IP addresses.

5. Manage Access Token Groups

Select the group where this access token will be managed.

  • Use the search box to find the appropriate group.
  • Click the group name from the list.
  • Once a group is selected, the list of group members appears in the right panel.
  • Check the members who will have access to the Access Token.
note

Create New Group If a group is not yet available, click this button to create a new group.

6. Save the Configuration

Once everything is filled in, click the Create Token button to save the new access token to the system.

After clicking Create Token, a notification appears indicating that the Access Token was successfully created. The generated API Key is displayed only once. Be sure to copy and store it in a safe place, because this key will not be shown again. Use the Copy button to copy the API Key to the clipboard.

2. List Access Token​

After the data is successfully created, users can view the list of saved access tokens on the Access Token Management page.

The following describes each column displayed in the table:

  • Token Name: Displays the name of the created access token.
  • Group: Displays the group associated with the access token.
  • Valid: Displays the validity status of the access token.
  • Members: Displays the members who have access to the access token.
  • Updated By: Displays the user who last updated the access token.
  • Last Update: Displays the date and time of the last update.
  • Action: Contains a three-dot icon button for managing the access token, including editing, viewing the API key, regenerating the API key, and deleting the token.

At the bottom of the table, users can set the number of rows displayed via Rows per page, and navigate between pages using the available pagination.

3. Filter Access Token​

On the Access Token page, there is a Filter feature marked with a funnel icon. This feature helps users filter access tokens by certain criteria, making it easier to display relevant information.

The following are the steps to use the Filter feature on the Access Token page:

1. Open the Access Token Menu

Open the Access Token menu in the navigation panel to access the List Access Token page.

2. Open the Filter Panel

Click the Filter button at the top right of the table to display the filter options.

3. Set the Filter Criteria

  • Choose the desired filter criteria:
    • Group: Filter tokens by the associated group.
    • Updated By: Filter tokens by the user who last updated them.
  • Check one or more criteria as needed.

4. View the Filter Results

After selecting the filter criteria, the system automatically displays the list of access token data according to the selected filter.

5. Clear the Filter

  • To remove a specific filter, uncheck the selected option.
  • To remove all filters at once, click the Clear all filters button at the bottom of the filter panel.
  • After the filter is cleared, the system automatically displays all access token data without any filter restrictions.

4. Search Access Token​

The search feature makes it easy for users to find a specific Access Token without having to browse the entire list manually.

The following are the steps to use the search feature:

  1. Open the Access Token page from the navigation menu.
  2. Find the Search field at the top right of the table, next to the Filter button.
  3. Enter a keyword in the Search field. The keyword can be an Access Token name.
  4. The system automatically displays the list of Access Tokens that match the entered keyword.
  5. To display all data again, manually clear the keyword from the Search field.

5. Edit Access Token​

In the Access Token menu, users can update access token information as needed. The Edit feature allows changes to data such as the access token name, token description, expiration date, allowed IP addresses, group, and members.

The following are the steps to use the Edit feature for an Access Token:

1. Open the Access Token Menu

In the sidebar menu on the left, click Access Token to display the list of available access tokens.

2. Open the Action Menu

  • In the Action column of the access token row you want to edit, click the three-dot icon.
  • Click Manage or click the access token name to open the access token detail page.

3. Access Token Detail Page

At the top of the detail page are the access token name and its creation date (Created at), a Back to list button to return to the list, and Edit and Delete buttons on the top right.

The displayed information includes:

  • API Key: The unique key used for authentication, along with a Regenerate Key button.
  • Token Description: The description related to the access token.
  • Expiry Date: The API Key expiration date (such as Never Expires if it has no validity period).
  • Allowed IP Addresses: The allowed IP addresses.
  • Group and Members: The associated group and its members.
  • Activity Log: The access token activity history, such as creation and updates. Use the Load More button to display the full history.

4. Manage the API Key

In the API Key section there is a Regenerate Key button; this button updates the API Key and its validity period according to the defined settings. The old API Key will be deactivated, and users must use the new API Key to access the connected services.

5. Edit the Data

  • Click the Edit button at the top right of the page.
  • Make the necessary changes in the form that appears, such as:
    • Updating the Token Name.
    • Updating the Token Description.
    • Updating the Expiry Date.
    • Updating the Allowed IP Addresses.
    • Updating the Group and Members.

6. Save the Changes

  • After making changes, click the Save Change button to save the updated data.
  • The system displays a notification that the data was successfully updated.

6. Delete Access Token​

In the Access Token menu, users can delete access tokens that are no longer needed.

The following are the steps to delete an Access Token:

1. Open the Access Token Menu

In the sidebar menu on the left, click Access Token to display the list of available access tokens.

2. Select the Token to Delete

  • Find the token you want to delete in the List Access Token table.
  • In the Action column of the access token row you want to delete, click the three-dot icon.
  • Click Manage or click the access token name to open the access token detail page.

3. Click the Delete Button

  • Once the detail page opens, click the Delete button located at the top right of the page to proceed with the deletion.

4. Confirm the Deletion

  • After clicking the Delete button, the system displays a confirmation window to delete the Access Token.
  • At this stage, users are asked to enter the name of the Access Token to be deleted, matching the text shown on the screen.

5. Deletion Successful

  • After entering the Access Token name, click Yes, Delete to confirm the deletion.
  • The system displays a notification that the Access Token was successfully deleted.
info

Be sure to double-check before deleting an access token, because this action cannot be undone.

By following the steps above, you can easily and securely manage Access Tokens as needed on the TAKAKRYPT platform. Always keep your API Key confidential and manage it regularly to maintain system security.