Credentials
Within the Control Hub you can manage all the credentials needed from one centralised place. The credentials are used for the configurations and are assigned during their creation or editing.
New Credentials
Select New Credential.
Select the Credential Type.
Choose between Username and Password, Client ID and Secret, Secret Only, Certificate.
Certain configurations need certain types of credentials.
Username and Password
Credential ID - Enter an ID for this credential.
Credential Name - Enter a user friendly name for this credential.
Username - Enter the Username that is needed for access.
Password - Enter the password needed for this credential.
This will show a single dot once entered for security.
Notes - Add any information that can help identify what it can be used for.
Do not put the password or any clues here.
Expiry Date - Enter an Expiry Date for this credential.
This date will be used as a reminder that it needs updating. Even when it has expired it will continue to be used.
Select Create.
Client ID and Secret
Credential ID - Enter an ID for this credential.
Credential Name - Enter a user friendly name for this credential.
Client ID - Enter the Client ID that is needed for access.
Secret - Enter the secret needed for this credential.
This will show a single dot once entered for security.
Notes - Add any information that can help identify what it can be used for.
Do not put the secret or any clues here.
Expiry Date - Enter an Expiry Date for this credential.
On this date the credential will no longer be used.
Select Create.
Secret Only
Credential ID - Enter an ID for this credential.
Credential Name - Enter a user friendly name for this credential.
Client ID - This will display N/A and cannot be edited.
Secret - Enter the secret needed for this credential.
This will show a single dot once entered for security.
Notes - Add any information that can help identify what it can be used for.
Do not put the secret or any clues here.
Expiry Date - Enter an Expiry Date for this credential.
On this date the credential will no longer be used.
Select Create.
Certificate
Credential ID - Enter an ID for this credential.
Credential Name - Enter a user friendly name for this credential.
Client ID - This will display N/A and cannot be edited.
Password - Enter the password needed for the certificate.
This will show a single dot once entered for security.
Notes - Add any information that can help identify what it can be used for.
Do not put any clues here.
Expiry Date - Enter an Expiry Date for this credential.
On this date the credential will no longer be used.
Import Certificate - Drag and drop the certificate file or select browse files to find it within your file explorer.
The cert file must be a one of the following supported certificates:
application/x-pkcs12- .pfx or .p12application/pkix-cert- .cerapplication/x-x509-ca-cert- .cert
Select Create.
Find a Credential
You can find all your credentials within the Control Hub credentials space.
Searching for a Credential
Select the search bar on the credentials page.
Enter any part of a credential except the password to find it.
As you type within the search the list will start to refine.
When you enter a search it will look at all the fields including the notes and what it is used by but not the password.
Sorting Credentials
Credentials
Select the triangles or the table heading 'Credentials' to sort the table in alphabetical order. Credentials will be sorted based on the user friendly name.
Select it once to order them reverse alphabetically Z - A.
Select it again to order them alphabetically A - Z.
To reset the list order refresh the page.
Expiry Date
Select the triangles or the table heading 'Expiry Date' to sort the table in date order.
Select it once to order them longest time left to shortest time left, then expired.
Select it again to order them expired, shortest time left then longest time left.
To reset the list order refresh the page.
Edit a Credential
You can edit any part of a credential except the Credential ID. This is helpful when Passwords or Usernames need updating.
Find the credential you need to edit.
Select the action menu of that credential (Ellipses).
Select Delete from the menu.
This will open an edit credential modal.
Edit the fields you need to change.
If you need to change the Credential ID you need to create a new credential.
Select Save.
Any sources using an edited credential will automatically use the edited details once saved.
Delete a Credential
Credentials can only be deleted if they are not being used by a configuration. Within the Credentials table you can see if it is being used and by what in the Use By column.
Find the credential you want to delete.
Select the action menu of that credential (Ellipses).
Select Delete.
This will open a modal for you to confirm you want to delete this credential.
If you delete the wrong credential you will need to create it again as a new credential.
Last updated
