An organization is a group of one or more locations that helps you organize your fleet.
An organization is the highest level grouping in the Viam platform, which generally represents a company, or other institution. You can also use organizations for departments or other entities that can have one or more locations. If you are familiar with Google Drive, you can think of an organization as a shared drive.
When you or another user registers for an account with Viam, they become a member of an organization. If the user was invited to an organization, they become a part of that organization. If the user registered without invitation, an organization and a location is automatically created for the user.
A user can create more organizations at any time.
Any member of an organization can invite new users to that organization.
For example, you may have an account with one organization for your personal smart machines at home and another organization for the smart machines at work.
You organization is shown in the upper right corner of the Viam app. If you click on the organization dropdown, the app displays your name, email, and a list of organizations you belong to.
If you used an email invite to sign up, you have two organizations to begin with: the organization that invited you and a personal organization for other projects.
Click an organization’s name to navigate to its list of locations.
Create a new organization
To create a new organization, click on the Org’s Settings in the top right of the navigation bar. Then enter the name for your new organization in the New Organization field in the upper left of the page.
Share an organization
To invite a user to your organization, click on the Org’s Settings in the top right of the navigation bar. In the members section of the page, click on Grant access and enter their email address. Then select the resource that you would like to grant the user access to and the designated role and click Invite.
You can grant a user access to the following resources:
- an organization
- a location
- a machine
For more information on the permissions the roles assign for each resource, see Permissions.
Create a namespace for your organization
When uploading custom modules to the Viam registry, you must set a namespace for your organization to associate your module with.
To create a new namespace for your organization, click on the Org’s Settings in the top right of the navigation bar, then click the Set a public namespace button. Enter a name for your namespace, and then click Set namespace. Consider the following as you chose a namespace:
- A namespace may only contain letters, numbers, and the dash (
- Once set, a namespace cannot be changed: choose your namespace carefully!
- You must pick a unique namespace that is not already in use by another organization.
- As you enter your namespace, a message will appear to the right of the text box indicating whether the namespace is available, or whether an invalid character is detected.
Leave an organization
To leave an organization, click on the Org’s Settings in the top right of the navigation bar. Then click Leave organization.
Delete an organization
To delete an organization, click on the Org’s Settings in the top right of the navigation bar. Then click Delete organization.
If the organization to delete contains any locations, you must delete them before you can delete the organization.
Have questions, or want to meet other people working on robots? Join our Community Discord.
Was this page helpful?
Glad to hear it! If you have any other feedback please let us know:
We're sorry about that. To help us improve, please tell us what we can do better: