Managing Secret Keys
Back to Security Management Main Page
Table of Contents
Navigating to Secret Keys
FOUNDATION >SECURITY MANAGEMENT > MANAGE SECRET KEYS
What are Secret Keys
The Secret Keys module is used to generate Secret Keys that are registered to specific URL endpoints. Secret Keys are used by Webhooks in order generate a code that will be used by Third Party Systems to authenticate received data.
- Navigate to Secret Keys and explore existing entries via the Summary page.
- Click on the link (Name or Number) of the entry of your interest to enter the Data Entry page and see more detail.
- Use the Actions Menu to create a NEW Secret Key, modify (EDIT) or DELETE an existing one.
- Use BACK to return to the Summary page and CANCEL to revert any unwanted changes made to the Secret Keys.
Check the Validations Table below for a list of available Actions when working with Secret Keys, including each Action's related validations and restrictions. View the Attributes Table for a comprehensive description of the Secret Keys fields.
Validations
Action | Validations | Restrictions |
---|---|---|
Create |
|
|
Edit |
|
|
Delete |
|
|
Attributes
An * indicates a field is mandatory.
Name | Description |
---|---|
Main Information | |
Name * | The number of the Secret Key. |
Alternative Code* | The alternative code of the Secret Key. The alternative code is mandatory and unique and generated automatically based on the Secret Key Name, if not specified manually. |
Description | The description of the Secret Key. |
Type* | The type of the Secret Key. The supported value is the following:
|
URL Endpoint* | The URL endpoint associated with the key (e.g. www.crm.com) |
Key | The key that will be used to generate the authentication code. The key is generated automatically and is unique. |
Log Information | |
Log Details | The standard set of Log Details information available in all entities. |
Related Areas