Tokens can be thought of as API Tokens. Tokens can be set with different roles, that allow read-only tokens, and tokens for management, and tokens for CEWL.
Some important considerations
API Tokens cannot be used to interactively log in to the Portal.
When a company is created you usually have three tokens create:
Subscription token
Management token
Company Admin token
Some useful links:
API documentation please see below.
Token API
Please refer to swagger.ctci.ai for more details.
Tokens within the CTCI Portal
Select the menu option, Tokens.
Figure 1, Token Menu Option
The API Token's icon is a lock.
An API Token can be created by clicking the icon with the plus sign. It should look like something below.
Figure 3, Create a new API Token
The Id is actually the API token. The Save button is self-explanatory, the back button goes back to the list of API tokens.
Field Name | Details |
|---|---|
Id | The API Token |
Company Name | You can leave this as empty and it will take your current company, if you are managing a lot of Partner companies, then you can set it to one of these companies. |
Token Name | This is the name you would like to call you token. It is required |
Note | This is a note for the token, is is always handy to have a note to jog your memory, why this was created and what systems/processes use this token. |
Roles | This is what role the token will impersonate. No priveledge escalation is allowed, you cannot create tokens for which you don’t have that role already. |
Enabled | Whether the token is enabled or not |
Filter Conditions | Future - to support the API token only allowing a certain search filter |
Resource Permissions | Future - This will allow more granular access to columns and entities |
Token Expiry | Future - This would allow you to expire a token after a certain amount to time. |
How to Edit an API Token Entry
Go to the list of API Token entries by clicking on the Token Button, as mentioned in Figure 1.
Click on one of the entries.
Figure 4, Select an API Token entry to Show or Edit
The next page shown will be the show page, it shows all the details, to Edit, you must select the edit page. The reason we do this is if people have the audit role, they can only show and not edit, and by default, once the filter is set, it should be mainly viewing it then editing it, this will reduce accident changes.
Figure 5, Edit an API Token entry
Token Name is required to be entered.
Delete a Processed entry
Two ways to do it, within the edit page, see the icon above in Figure 5, Choosing an API Token Entry, and in the list view, select the checkbox and scroll all the way right and you will see a Delete icon. See Figure 6 below.
Figure 6, Deleting an API Token Entry