Equnix Metal
Loading...

Organizations

COMMAND LINE

Copy to clipboard

Organizations

Organizations are sets of users and projects. In order to deploy infrastructure, users must belong to an organization, which is a billing entity that sits one level above users.

If you sign up for Equinix Metal as an individual, you are made the owner of an organization that is tied to your user account. If you sign up for Equinix Metal through an invitation, you are added as a user to the organization that invited you. A user can be a member of many organizations.

When logged into the Equinix Metal console, you can find a list of the organizations you are a member of from the Organizations page. You can also get the list by sending a GET request to the /organizations API endpoint.

If you are a member of multiple organizations, you can switch between them by clicking your user icon and selecting Change Organization.

Team Members and Roles

Each organization has a primary owner, who is ultimately responsible for all activity in an organization. Additional team members can be added with the following permissions:

  • Admin - The Admin role has full control over the Organization.
  • Collaborator - A Collaborator has access to project-specific resources.
  • Limited Collaborator - A Limited Collaborator has access to projects, but does not see billing or pricing information.
  • Billing - Users with the Billing role have have access to the billing portion of the Organization.

Adding Members to an Organization

If you are an Owner or an Admin, you can invite new users to your organization. Click your user icon and select Teams, which will open the Teams tab of your Organization Settings. Click + Invite New Member to bring up a panel where you can add a single member or multiples at once. Each email added will receive an automated response from our platform with a verification link (to either accept/deny) the invitation. Users with outstanding invitations appear in the list of Team Members, with the option to resend the invitation email or copy their invite link.

You can also send invitations through the API using the /organizations/{id}/invitations endpoint.

Managing Team Members

An Owner or Admin can also manage users in the organization from the Team Memebers list on the Teams tab of Organization Settings. Click on a user to open a panel where you can update the role or remove them from your organization.

Organization Settings

As a member of an organization, information and settings related to that organization on the Organization Settings page. The amount of information the Organization Settings page varies depending on the role that you have in that organization. Similarly, you can retrieve organization information with a GET request to the /organizations/{id} endpoint, and the information in the response will vary on your role.

General information about the organization is on the General panel, including the organization name and ID. Each organization has a unique ID, which is used to reference the organization in the API and allows the organization to be renamed at any time.

Sample General Organization Settings panel

If you are an Admin of an organization you have the ability to:

  • Manage the information and settings on the General panel.
  • Manage users on the team, their roles, and which projects collaborators have access to.
  • Access the billing information and manage payment methods.
  • Manage the organization's projects.
  • Manage the hardware reservations for your organization.
  • Leave the organization.

If you are a Collaborator in an organization you can:

  • See and manage the projects that you are granted access to.
  • See the hardware reservations of the projects that you have access to.
  • Leave the organization.

If you are a Limited Collaborator in an organization you can:

  • See and manage the projects that you are granted access to, except for billing and pricing information.
  • See the hardware reservations of the projects that you have access to. However, Limited Collaborators are not able to makes requests for more reserved hardware.
  • Limited Collaborators do not have access to the Spot Market.
  • Leave the organization.

If you are Billing member of an organization you can:

  • Access the billing information and manage payment methods.
  • Leave the organization.

Owners can do all of the above, except for leaving an organization. They are the only members that can delete an organization.

Optional Preferences

If you are an Admin or Owner of an organization, there are a few optional preferences that you can set on the General settings page.

The first two allow you to add specific email addresses for maintenance emails and abuse emails. If no email addresses are specified, the emails will go to the Owner's email address by default.

The second two settings are billing and invoice related. If you need to add a VAT or Tax ID number to your invoice, check Yes and fill the number into the Tax ID field. Similarly, if you need to have customized invoices, check Yes and fill out the fields with the information that you need to have on your organizations invoices.

If you change any of the settings on the page, click Save to save and apply the changes.

Leaving an Organization

You can choose to leave an organization by by clicking your user icon and selecting Settings. On the Leave tab of the Organization Settings, click Yes I want to leave this organization. I understand this action will not be reversible. Once you leave an organization, you cannot access any of the organization's settings or projects. You will have to be re-added by an Admin or Owner.

Entitlements

Entitlements are set on an organizational level, and determine how many projects your organization can have, which locations you can deploy severs, and which servers you have available to you. You can create or belong to many organizations at once, so you may find that as part of an corporate organization you are able to access more locations and servers than in an organization that is just tied to your individual user account.

When you go to provision servers using the Equinix Metal console, your options are automatically filtered to the locations and hardware available to your organization. If you want to list the organization's entitlements you can do so through the API.

Organizations and Projects

Projects sit one level below Organizations and are used to logically group infrastructure. Projects can have their own sets of users, as a subset of the Organizations users.

  • Owners and Admins have access to all of the Projects in an Organization
  • Collaborators can have access to Projects assigned to them on a project-by-project basis.

Each Project generates its own invoice and the invoices are then billed to the Organization each month.

Documentation on Projects and project-level operations is on the Projects page.

Deleting an Organization

Deleting an organization is permanent.

Owners of an organization are the only user that can delete it, but there are also a few conditions that have to be met in order to delete an organization.

  • You can't delete an organization that contains projects. You have to delete or transfer all projects out of the organization before deleting it.
  • You can't delete an organization that has outstanding charges. All invoices generated by the projects in an organization must be paid before deleting the organization.

To delete an organization, click your user icon and select Settings, which will open the Organization Settings page. You can delete the organization when all of the conditions are met from the Delete panel.

In the API, you can delete an organization by sending a DELETE request to the /organizations/{id} endpoint. If your organization does not meet the conditions for deletion, it will return an error.

Frequently
asked questions

Slack

Still stuck?

Join us on Slack

Get support from our team and community members.

Frequently asked questions

What 3rd party Managed Services?

Neutra trust fund narwhal, palo santo bicycle rights live-edge stumptown health goth portland selfies kinfolk woke. ssss Echo park irony artisan vaporware typewriter. Next level pinterest drinking vinegar lyft mumblecore af small batch heirloom VHS. Fixie banh mi asymmetrical trust fund.

What 3rd party Managed Services?

Neutra trust fund narwhal, palo santo bicycle rights live-edge stumptown health goth portland selfies kinfolk woke. ssss Echo park irony artisan vaporware typewriter. Next level pinterest drinking vinegar lyft mumblecore af small batch heirloom VHS. Fixie banh mi asymmetrical trust fund.

What 3rd party Managed Services?

Neutra trust fund narwhal, palo santo bicycle rights live-edge stumptown health goth portland selfies kinfolk woke. ssss Echo park irony artisan vaporware typewriter. Next level pinterest drinking vinegar lyft mumblecore af small batch heirloom VHS. Fixie banh mi asymmetrical trust fund.

Copied code to clipboard