My Account
To view your account information, choose the My Account item from the main menu.
'My Account' has the following sections:
Licence information
Your licence information is displayed in the first panel of My Account, and contains information about your licence tier and the restrictions associated with that licence. If there are any issues, such as an expired licence or breach of licence restrictions, they will also be shown here.
You can get more information about licensing from the Licensing guide.
Uploading a new licence
A new licence file (.lic
format) can be uploaded by clicking the
button:
A new panel will be displayed with the option to upload a new licence by clicking the Upload licence button and selecting the file from your computer:
Download usage
Detailed usage data can be downloaded as a JSON file that consists of:
- Your DataMasque version
- The date that the usage data was exported
- Usage details of all database instances that have been masked by DataMasque. Each usage entry reports on a single database instance, and
contains:
- An anonymised database identifier
- The largest recorded database instance size in GiB
- The expiry date of this usage entry
- The number of masking runs executed against this instance
- The database type
- The date this usage entry was last updated
- The uuid of the licence installed when the instance was last masked
- A summary of usage details. This includes:
- The installation date of this DataMasque instance
- The latest date any usage entry was last updated
- The uuid of the licence installed during the most recent masking run
- An aggregated usage summary
- A checksum to validate data integrity
To download the usage JSON file, click the DOWNLOAD USAGE button on the Licence Information panel.
Send Usage
DataMasque Limited may require you to share usage data before issuing a renewal or upgraded licence.
To share the above usage data with DataMasque Limited, click the SEND USAGE button on the Licence Information
panel, and confirm with the SEND button on the pop-up dialog to proceed.
On confirmation, an email will be sent to DataMasque Limited containing your licence usage information (as detailed in the Download usage section). The email is sent using the SMTP configuration provided in the application settings. The DataMasque instance's admin user and yourself will also be BCC'd on this email.
Note: The SEND USAGE button may be disabled if SMTP settings are missing.
Account Information
Your user account information is displayed in the second panel of 'My Account'. It shows your user account details and an API key you can use to automate tasks using the DataMasque REST API (see Best Practices).
Revoking Your API Key
In case your API key is compromised, it can be revoked (and a new one provisioned) by clicking the button. Before revoking, ensure that the key is no longer required by any integrations you have developed using the DataMasque REST API.
Updating Account Information
Basic user account information such as email address and password can be updated by clicking the button. A form will be displayed allowing you to update this information. Using this form, you can also opt in or opt-out of receiving email updates when new unmasked sensitive data is found during sensitive data discovery.
For users who authenticate with single sign-on, certain account details such as email address and password cannot be updated from DataMasque.
Git SSH key information
Your Git SSH key information is displayed in the Git SSH Key panel of My Account. It contains information about your Git SSH key, that will be used to authenticate the connection to the remote Git repository.
Note: Git SSH key management is only available for
Admin
users andMask Builder
users. Each user can only store one SSH key.
Uploading a Git SSH key
A Git SSH key file (often named id_rsa
) can be uploaded by clicking the
button,
or by clicking the button
if you have already uploaded a Git SSH key file.
A new panel will be displayed. Enter a name for the key or leave it blank to use the file name. Click the Choose File button and select the Git SSH private key file from your computer. Finally, click the upload button to finish uploading your Git SSH key.
Ensure the SSH key you upload is authorized in your Git repository. You may wish to create a separate SSH key for DataMasque to use.
Deleting a Git SSH key
Your Git SSH key can be deleted by clicking the Delete Key button from Git SSH Key Information panel.
Git Directory information
If Git Integration is enabled on your DataMasque instance, you can specify the Git directory to store rulesets on an individual user basis. Once defined, the specific user's Git directory will take precedence over the global directory set up by an Admin user in the Settings page.
When you are setting up the Git directory:
- Choose Global Directory if you want to use the directory specified globally.
- If you have a specific directory for the current user, select Custom Directory and provide the path.
- If you intend to use the repository root, simply leave the text field blank.
Note: Only
Admin
andMask Builder
users have access to this Git directory feature.