Organization Admin Guide

On this page, we walk you through how to perform common organization administrative tasks (i.e. adding and removing members from the org). These operations are restricted to only org admins -- org members with ADMIN membership level.

For more general information about orgs, please see the Organizations on DNAnexus page. For a list of other org-related operations, please see the Organization Member Guide.

Note: This functionality is also available in the UI. You may find UI tools easier for performing actions such as quickly viewing org members and projects. For more information, please see the Org Admin UI guide.
Minimum dx-toolkit version: These tools are only available in dx-toolkit v0.178.0 or later. To upgrade to the latest version of dx-toolkit, please run dx upgrade or visit our downloads page.

Update Org Policies

You can use the dx update org command to update your org policies.

To update the membership list visibility policy so all org members can view the list of org members, use the following command, replacing org-demo with your org ID.

$ dx update org org-demo --member-list-visibility MEMBER Updated org-demo

To update the restrict project transfer policy so that only org admins can change the billing account of an org project, use the following command, replacing org-demo with your org ID.

$ dx update org org-demo --project-transfer-ability ADMIN Updated org-demo

For general information about org policies, please see the Organizations on DNAnexus page.

Back to top of page

Edit Org Membership

Add new members to an org

The dx add member command allows org admins to add existing DNAnexus users to a pre-existing org. The command will add a member to the org but will not set their default billing account; the member will have to set their own default billing account. Additionally, if the member has any pre-existing projects that are not billed to the org, the user will need to transfer the project to the org if they wish to have the project billed to the org.

Below are some examples of adding users to an org.

To add an existing user to an org with:

  • Membership level: MEMBER
  • Billable activities access: Allowed
  • Shared apps access: Allowed
  • Shared projects access: CONTRIBUTE

Use the following command, replacing org-demo with your org ID and xxxx in user-xxxx with the new member's username.

$ dx add member org-demo user-xxxx --level MEMBER --allow-billable-activities --project-access CONTRIBUTE Invited user-xxxx to org-demo

To add an existing user to an org with:

  • Membership level: MEMBER
  • Billable activities access: Not allowed
  • Shared apps access: Not allowed
  • Shared projects access: VIEW

Use the following command, replacing org-demo with your org ID and xxxx in user-xxxx with the new member's username.

$ dx add member org-demo user-xxxx --level MEMBER --project-access VIEW --no-app-access Invited user-xxxx to org-demo

To add another org admin to the org, use the following command, replacing org-demo with your org ID and xxxx in user-xxxx with the new member's username.

$ dx add member org-demo user-xxxx --level ADMIN Invited user-xxxx to org-demo

For more information about adding members to an org, use the dx add members command with the -h flag. For general information about org membership, please see the Organizations on DNAnexus page.

Back to top of page

Update membership access

The dx update member command allows org admins to update a member's access within an org.

To grant an existing org member billable activities access, use the following command, replacing org-demo with your org ID and xxxx in user-xxxx with the member's username.

$ dx update member org-demo user-xxxx --level MEMBER --allow-billable-activities true Updated membership of user-xxxx in org-demo

To grant an existing org member shared projects access, use the following command, replacing org-demo with your org ID and xxxx in user-xxxx with the member's username.

$ dx update member org-demo user-xxxx --level MEMBER --app-access true Updated membership of user-xxxx in org-demo

To update an existing org member's shared projects access, use the following command, replacing org-demo with your org ID, xxxx in user-xxxx with the member's username, and ACCESS with one of ADMINISTER, CONTRIBUTE, UPLOAD, VIEW, or NONE.

$ dx update member org-demo user-xxxx --level MEMBER --project-access ADMINISTER Updated membership of user-xxxx in org-demo

To make an existing org member an org admin, use the following command, replacing org-demo with your org ID and xxxx in username with the member's username.

$ dx update member org-demo user-xxxx --level ADMIN Updated membership of user-xxxx in org-demo

For more information about updating members' access and level in an org, use the dx update members command with the -h flag. For general information about org membership, please see the Organizations on DNAnexus page.

Back to top of page

Remove a member from an org

Org admins can remove a member from an org using the dx remove member command. This command will remove the user from the org, revoking the user's access to projects and apps shared with the org. This command will also, by default and if applicable, remove the user's access to apps and projects billed to the org.

To remove a member from an org, use the following command, replacing org-demo with your org ID and xxxx user-xxxx with the member's username. You will be prompted to confirm the removal of the user from the org.

$ dx remove member org-demo user-xxxx WARNING: About to remove user-xxxx from org-demo; project permissions will be removed and app permissions will be removed Please confirm [y/n]: y Removed user-xxxx from org-demo Removed user-xxxx from the following projects: None Removed user-xxxx from the following apps: None

For more information about removing members from an org, use the dx remove members command with the -h flag.

Back to top of page

Billing and Finance

Set or update org billing information

Org admins can set or update billing information for their respective orgs in the profile settings page. This page is accessible by clicking on your name in the header and going to "Profile". You can edit your billing information and set your default billing account in the "Account" tab, under "Billing Accounts".

On this page, you will see all all the orgs you administer as well as all the orgs where you have been granted billable activities access. To set the billing information for an org you administer, click on the "View/Edit Info" link for your org's billing account and fill out the form.

Screenshot of the billing information information tab in the user's profile page

By setting the billing information for an org, you are designating somebody to be responsible for handling invoices sent by DNAnexus. This person can be you, somebody within your company's finance department, or someone else. All invoices will be sent to the person listed in the billing information.

Once you click the "confirm billing" button, an email will be sent to the billing email address asking for confirmation. Until the billing recipient activates the confirmation link contained in the email, your billing account will not be updated. Orgs must have confirmed billing information or a non-negative spending limit remaining in order to incur charges on behalf of the org.

Back to top of page

View historical charges and spending limit

You can view the historical charges for your org -- total storage costs, compute costs, and estimated spending limit remaining (if applicable) -- in the "Billing Information" tab of your profile page. This page is accessible by clicking on your name in the header and going to "Profile". You can edit your billing information and set your default billing account in the "Account" tab, under "Billing Accounts".

Back to top of page

Set a spending limit for your org

If you are an org admin, you can set a spending limit for your org by contacting support@dnanexus.com from the email address associated with your DNAnexus account. Each org can have a single spending limit for org activities and spending limits can be increased or decreased by the org admin. Spending limits can help you associate your activities on DNAnexus to a fixed budget amount or to a purchase order.

Back to top of page

Learn More About An Org

List all org members

To list all the members of an org, use the dx find org members command, replacing org-demo with your org ID.

# List all org members & admin $ dx find org members org-demo user-xxxx : Jane Doe (ADMIN) user-yyyy : John Doe (MEMBER) # List only org admin $ dx find org members org-demo --level ADMIN user-xxxx : Jane Doe (ADMIN) # Return only user IDs of org members & admin $ dx find org members org-demo --brief user-xxxx user-yyyy

Back to top of page

List all org projects

To list all org projects, including projects to which you do not have access, use the dx find org projects command, replacing org-demo with your org ID.

# List all org projects $ dx find org projects org-demo project-xxxx : my_new_project (ADMINISTER) project-yyyy : example_project (CONTRIBUTE) # Return only the project IDs for all projects billed to the org $ dx find org projects org-demo --brief project-xxxx project-yyyy # Return JSON-formatted string of org projects and project metadata $ dx find org projects org-demo --json [ { "level": "ADMINISTER", "describe": { "id": "project-xxxx", ... You can also use JQ (a [command-line JSON parser](https://stedolan.github.io/jq/)) to format a command-delimited list of project-ID, project name, your access level , project creator, and number of bytes stored in the project. $ dx find org projects org-demo --json | jq -r '.[] .describe | .id + "," + .name + "," + .level + "," + .createdBy.user + "," + (.dataUsage | tostring)' project-xxxx,my_new_project,ADMINISTER,user-xxxx,0.059 project-yyyy,example_project,CONTRIBUTE,user-yyyy,0.048

Back to top of page

List all org apps

To list all the apps billed to your app, use the dx find org apps command, replacing org-demo with your org ID.

# Return list of all org apps $ dx find org apps org-demo Example App (example_app), v0.0.1

Back to top of page

Grant Yourself Access to Org Objects

Give yourself access to any org project

Org admins can give themselves access to any project billed to the org by using the dx invite command. To invite yourself to a project with ADMINISTER access, use the following command, replacing project-xxxx with the project ID of the org project you want access to and user-xxxx with your username. The --no-email flag will suppress the email that would normally be sent notifying you that you have been given access to a project.

$ dx invite user-xxxx project-xxxx --no-email Invited user-xxxx to project-xxxx (accepted)

For more information about inviting yourself to a project, use the dx invite command with the -h flag.

Back to top of page

Grant yourself access to any org app

Org admins can grant themselves developer access to any app billed to the org. App developers can publish new app versions, deprecate old app versions, and manage the group of developers and authorized users of the app.

$ dx add developers app-xxxx user-xxxx

Back to top of page

Advanced Org Options

Provision new DNAnexus accounts

Org admins have the ability to provision new DNAnexus accounts on behalf of the org. The user will then receive an email with instructions to activate their account and set their password. This feature is not available by default -- if you are an org admin, please contact support@dnanexus.com for more information about provisioning user accounts.

If this feature has already been turned on for an org you administer, you can create new accounts using the dx new user command.

To create a new user and add them to your org as a member with billable activities access and set their default billing account to the org, use the following command. You will need to provide the following information:

  • EMAIL: the user's email -- there cannot be multiple accounts associated with the same email
  • USERNAME: the user's username -- must be a unique username
  • FIRST: the user's first name
  • LAST: the user's last name
$ dx new user --username USERNAME --email EMAIL --first FIRST --last LAST --org org-demo --level MEMBER --set-bill-to Created new user account (user-xxxx)

For more information about provisioning new user accounts, run the dx new user command with the -h flag.

Back to top of page

Enable PHI features for your org

PHI (Protected Health Information) refers to identifiable health information that can be linked to a specific person. PHI Data Protection guards the confidentiality and integrity of the data stored in your project in compliance with HIPAA. You must sign a BAA (Business Associate Agreement) with DNAnexus in order to enable this feature.

If you are an org admin and interested in enabling PHI features for your org, please contact support@dnanexus.com.

Back to top of page

Last edited by Samantha Zarate, 2017-08-14 16:24:53

 Feedback