DataMasque Portal

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.

On this screen, if you are running DataMasque on an AWS EC2 instance (including EKS), you can also select to check out a Contract Licence from your AWS account, instead of using the licence from the licence file.

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  Add Button  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:

Upload licence Button

Note that some licences can not be replaced. If you have purchased DataMasque through a marketplace (e.g. AWS or Azure), you will not be able to upload new licences, except for BYOL licence products.

File Based vs. Cloud Licences

DataMasque offers two methods for licence acquisition: file-based and cloud-based (AWS Contract Licence). You can choose which method DataMasque uses to obtain its licence, offering flexibility depending on your deployment environment and licensing model.

On the My Account screen, you can switch between these two licence types under the following conditions:

  • You are running on an EC2 instance (including EKS).
  • You are using a non-consumption licence (i.e., not an hourly AWS product). This includes Standard, Free Trial, and other perpetual licence types.
  • DataMasque instances without valid licences (i.e., restricted or expired licences) can also choose to switch to the AWS cloud contract licence.

If you are already using a cloud contract licence, the option to choose between File and Cloud will not be displayed. This is because both options result in the same outcome: the licence is checked out directly from AWS.

There are three variations of the licensing screen, each reflecting a different state and availability of licence options:

  • File-Based Licence Only (No Cloud Option)
  • File-Based Licence with Cloud Option
  • Cloud Contract Licence

Variation 1: File-Based Licence Only (No Cloud Option)

This screen is displayed if you have a file-based licence, but you cannot switch to a cloud-based licence. This typically indicates one of two scenarios:

  • You are not running DataMasque on an EC2 instance. Cloud Contract licensing is only available for EC2 deployments.
  • You are using a consumption-based (e.g., hourly) AWS product for DataMasque. Cloud Contract licensing is not compatible with consumption-based licensing.

Licence Variation 1: File-Based License Only

If you believe you should have the option to switch to a cloud licence (i.e., you are on EC2 and using a non-consumption licence), please check your instance's IMDS (Instance Metadata Service) configuration to ensure it is correctly configured.

Variation 2: File-Based Licence with Cloud Option

This screen is displayed if you are currently using a file-based licence, and you have the option to switch to a cloud-based licence.

To switch:

  • Select the AWS Contract Licence option.
  • Choose the appropriate licence type (Business or Enterprise) that corresponds to your AWS contract.
  • Click *Save and *Check Out Licence* to switch to cloud licensing.

Licence Variation 2: File-Based License with Cloud Option

To switch back to file based licensing, select the Use licence file and click Save.

Variation 3: Cloud Contract Licence

This screen is displayed if your licence file is already configured to use contract licensing. To activate or refresh your cloud licence:

  • Select the licence type (Business or Enterprise) that corresponds to your AWS contract.
  • Click Save and Check Out Licence to check out the cloud licence.

Licence Variation 3: Cloud Contract Licence

Automatic Licence Renewal

Cloud licences are checked out or renewed in the background approximately every hour while DataMasque instance is running. This ensures that your DataMasque instance always has a valid licence.

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).

Account Information

Revoking Your API Key

In case your API key is compromised, it can be revoked (and a new one provisioned) by clicking the  Revoke API Key  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  Edit Button  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.

Edit Account Form

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 and Mask Builder users. Each user can only store one SSH key.

Git SSH Key Information

Uploading a Git SSH key

A Git SSH key file (often named id_rsa) can be uploaded by clicking the  Add Button  button, or by clicking the  Edit Button  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.

Git SSH Key Upload

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.

User Git Directory Setting

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 and Mask Builder users have access to this Git directory feature.