Managing Sandbox Accounts

You can test system updates that are upcoming in the OneTrust platform before they are made live across all environments by creating a sandbox account. When a sandbox is created, the sandbox will contain a copy of the configuration data from the parent account that can then be tested and altered within the sandbox without any effect to the configuration data within the parent account. If needed, the sandbox can later be refreshed to keep the configuration data aligned with the parent account.

Note:

For more information on sandbox accounts, see Sandbox Management Overview.

To create a sandbox

  1. On the Global Settings menu, select General Settings > Sandbox Management. The Sandbox Management screen appears.
    Note:

    Sandbox accounts can only be created and managed from the root organization.

  2. Click the Create Sandbox button. The Create Sandbox modal appears.


    Field
    Description
    Parent Account

    Indicates the name of the current account that you are cloning to create a sandbox.

    Name

    Enter a name for the sandbox, up to a maximum of 30 characters. This will be used to generate the Account Name, Application Sandbox Domain, and Data Subject Portal Sandbox Domain.

    Description

    Enter a description for the sandbox.

    Sandbox Administrator

    Indicates that the current user creating the sandbox will be the Sandbox Administrator by default.

  3. Complete the fields.
  4. Click the Create button. The Creating Sandbox modal appears with details for your sandbox.
    Note:

    For more information on accessing your sandbox once created, see Accessing Sandbox Accounts.



    Note:

    If the Purchase Additional Sandbox Licenses modal appears instead of the Creating Sandbox modal, then you have reached your sandbox limit. If you would like to purchase additional sandboxes, you can click the Contact Sales button to submit a request to your OneTrust Account Representative.



To view sandbox details

  1. On the Global Settings menu, select General Settings > Sandbox Management. The Sandbox Management screen appears.

  2. Select the sandbox for which you want to view details. The Sandbox Details screen appears.


    Field
    Description
    Name

    Name of the sandbox defined during sandbox creation.

    Account Name

    Name generated for the sandbox by appending the ID of the parent account to the name defined for the sandbox.

    For example, if Gilbert Hughes - Sandbox is entered in the Name field during sandbox creation and the parent account ID is 25759, the Account Name for the sandbox will be Gilbert Hughes - Sandbox_25759.

    Parent Account

    Name of the parent account from which the sandbox was created.

    Description

    Description of the sandbox defined during sandbox creation.

    Created By

    Name of the user who created the sandbox.

    Date Created

    Date and time that the sandbox was created.

    Administrator

    Name of the user configured as the Sandbox Administrator.

    Status

    Status that indicates availability of the sandbox.

    Application Sandbox Domain

    URL of the OneTrust platform for the sandbox.

    Data Subject Portal Sandbox Domain

    URL of the Data Subject Portal for the sandbox.

To edit a sandbox name

After a sandbox is created, you can change the sandbox's name if needed. This will update the name of the sandbox that appears within the OneTrust Platform. The current name of the sandbox contained within the Application Sandbox Domain and Data Subject Portal Sandbox Domain URLs cannot be replaced and will remain unchanged.

  1. On the Global Settings menu, select General Settings > Sandbox Management. The Sandbox Management screen appears.

  2. Click the Context Menu icon corresponding to the sandbox that you want to rename.
  3. On the Context menu, select Edit name. The Edit sandbox name modal appears.


  4. Enter a new name for the sandbox.
  5. Click the Save button.

To refresh a sandbox

In order to keep a sandbox aligned with production, the sandbox can be refreshed. When a sandbox is refreshed, the sandbox will be cleared of all data and will be re-seeded with a copy of the current configuration data from the parent account. The sandbox will only retain the following data after the refresh:

  • Account name

  • Description

  • Administrator

  • Application Sandbox Domain

  • Data Subject Portal Sandbox Domain

  • Single Sign-On (SSO) configuration

  • Client Credentials

All other configuration data will be purged from the sandbox, including sandbox-only users. Upon refresh, all users and roles will be copied from the parent account to the sandbox account. All users, with the exception of the Sandbox Administrator, will be marked as Inactive within the sandbox. However, the Sandbox Administrator can reactivate any users and add new users directly to the sandbox. Sandbox-only users who previously had access to the sandbox account prior to the refresh will be deleted and will need to be re-added.

  1. On the Global Settings menu, select General Settings > Sandbox Management. The Sandbox Management screen appears.

  2. Select the sandbox that you want to refresh. The Sandbox Details screen appears.


  3. Click the Refresh Sandbox button. The Refresh Sandbox modal appears.


  4. Confirm that you want to proceed with refreshing the sandbox by acknowledging the statement.
  5. Click the Confirm button. The Refreshing Sandbox modal appears and the copy is initiated.