User Accounts

COMMAND LINE

Copy to clipboard

User Accounts

When you sign up for Equinix Metal™, you get a user account. Your user account is where you can manage:

  • Your profile and log-in information.
  • Your security settings.
  • SSH Keys tied to your user.
  • API Keys tied to your user.

Profile

Your user profile consists of your name, email, and phone number. Your email is used for sign-on and communication preferences. You may have more than one email tied to your user account. Your phone number is optional, but can be used for things like two-factor authentication.

You can access and update your profile on the Equinix Metal console from your Personal Settings, on the Profile tab.

User Profile Page

Or you can manage your profile through the API using the /user endpoint. To view your user profile send a GET request:

curl -X GET -H 'X-Auth-Token: <API_TOKEN>' https://api.equinix.com/metal/v1/user

To update your user profile, send a PUT request to /user, with the fields containing the updated information in the request body.

curl -X PUT \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN>" \
"https://api.equinix.com/metal/v1/user" \
-d '{ 
        "first_name": "string", 
        "last_name": "string", 
        "phone_number": "string", 
        "timezone": "string", 
        "password": "string"
    }'

Security Settings

The Security tab of your Personal Settings handles settings relating to your password, two-factor authentication (2FA), and the Doorman VPN.

To change your password, enter your current password and the new password and click Change. To change your password through the API, you can send a PUT request to the /user endpoint, with the new password in the "password" field of the request body.

curl -X PUT \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN>" \
"https://api.equinix.com/metal/v1/user" \
-d '{  
        "password": "string"
    }'

Documentation and API examples are for 2FA are available on the Two-factor Authentication page. Documentation and API examples for using the Doorman VPN are on the Doorman VPN page.

API Keys

A user-level API key is your authentication token for the Equinix Metal API across the projects and organizations that you have access to. You can have multiple API keys tied to your account.

SSH Keys

A list of SSH keys that are tied to your user account is on the SSH Keys tab. SSH keys that are tied to your user account will be included on all new servers in the projects that you own, or of which you are a collaborator. Documentation on how to generate and manage SSH Keys is covered in SSH Keys.

Users and Organizations

For billing, entitlement, and collaboration purposes, all Equinix Metal users are part of an organization. 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.

Documentation on organizations, user roles, and entitlements, is on the Organizations page.

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