API DocumentationProduct Documentation
Product Documentation

Create and Manage Organizations

Suggest Edits

🚧

IMPORTANT

The following procedures apply to customer hosted Tetra Data Platform (TDP) deployments only. To create and manage organizations in a Tetra hosted TDP deployment, you must contact your customer success manager (CSM).

When using the ts-admin role in a customer hosted TDP deployment, you can use the Manage Organizations page to do any of the following:

🚧

IMPORTANT

Do not use the Create Tenant action on the Manage Organizations page without consulting your customer success manager (CSM) first. The TetraScience team will help you create a new tenant with the correct configurations if needed.

Access the Manage Organizations Page

To view the Manage Organizations page, do the following:

  1. Sign in to the TDP with a ts-admin role.
  2. In the left navigation menu, choose Administration.
  3. Choose Manage Organizations. The Manage Organizations page appears.

Manage Organizations page

Create a New Organization

📘

NOTE

Password policies for each organization must be configured at the tenant level on the Tenant Settings page. For instructions, see Set Password Policies.

To create a new organization, do the following:

  1. Open the Manage Organizations page as a user with a ts-admin role.
  2. Choose Create Organization. The Create Organization dialog appears.
    Create Organization dialog
  3. For Organization name, enter a name for the org.
  4. For Slug, enter a short orgslug value. Use lowercase characters, numbers, and hyphens only.
  5. For Email domain name, enter the email domain name that you want the org to have. Use lowercase characters, numbers, and hyphens only.

🚧

IMPORTANT

You can't change an organization's slug or email domain after it's created.

  1. (Optional) To activate compliance features for the new organization, move the Enable Compliance Features toggle to the right. For more information, see Set Compliance Settings for Your Organizations.
  2. Choose Save.

📘

NOTE

Based on your specific AWS or network setup, creating a new organization may not be successful because of proxy or firewall restrictions. As a result, you may see various issues when uploading files, such as KMS errors, missing Data Hub policies, and more. To verify that your organization can communicate with AWS, see Make Sure that Your Organization Can Communicate with AWS.

Search for a Specific Organization

To search for a specific organization, do the following:

  1. Open the Manage Organizations page as a user with a ts-admin role.
  2. Enter the organization's name in the upper left search box. Organizations that match your search criteria appear.

Switch Between Organizations

To switch between organizations, do the following:

  1. Open the Manage Organizations page as a user with a ts-admin role.
  2. In the list of organizations, find the organization that you want to switch to. Then, select the far right Switch button in that organization's row. The selected organization becomes active (indicated by a gray Current label and by the current organization name label displayed at the bottom of the page). The previous organization becomes inactive.

📘

NOTE

To set your default organization, see Account Details.

Make Sure That Your Organization Can Communicate with AWS

To make sure that each organization you create is able to communicate with AWS through the TetraScience API, do the following:

  1. Open the Manage Organizations page as a user with a ts-admin role.
  2. In the list of organizations, find the organization that you want to confirm can connect with AWS.
  3. On the right side of the organization's row, select the AWS button. A Success! message displays indicating communication has been established.
  4. Choose Dismiss.

AWS KMS Key Rotation

📘

NOTE

Starting in TDP v3.6.0, all new AWS Key Management Service (AWS KMS) keys automatically rotate their key material every year (approximately 365 days from their creation). For existing AWS KMS keys that were created before TDP v3.6.0, customers must activate automatic key rotation manually in the TDP. For more information, see Rotating AWS KMS keys in the AWS Documentation.

Activate AWS KMS Key Rotation for Keys Created Before TDP v3.6.0

To manually activate automatic key rotation for an AWS KMS key created before TDP v3.6.0, follow the instructions in Make Sure That Your Organization Can Communicate with AWS. When you select the AWS button, a Success! message displays indicating that automatic key rotation is now activated for the organization’s associated AWS KMS key.

Updated 8 months ago