Skip to main content
Equinix Deploy

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.

Your 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 multi-factor authentication.

To access your user Profile in the Equinix Metal console, click on your user icon, and click My Profile.

Accessing My Profile

You can access and update your profile on the Overview tab.

User Profile Page

You can retrieve your user information from the CLI with the metal user get command.

metal user get

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 the /user endpoint, 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"
    }'

Changing Your Password

You can update change your password on the Security tab of your Profile. Enter your current password in the and the new password and click Save new password.

Change Password Fields in Personal Settings

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"
    }'

If you have lost your password and need to reset it, please use the Forgot password? link on the sign-in page, or contact support.

Multi-factor Authentication

Multi-factor authentication (MFA) allows you to configure an additional means of authentication on your account, reducing the risk of account takeover or other malicious activity. Each time you log into your account, you will have to provide an authorization code from either an authenticator app or an SMS text message. Data rates may apply.

Enabling MFA

Multi-factor authentication set up is on the Security tab of your Profile. When 2FA is inactive, you have the option to either Setup with App or Use SMS. Choose which method you would like to use.

App Setup - If you choose to use an app, then the Enable MFA Using an App panel appears. Use your choosen app to scan the QR code, or click Copy secret as text which will copy the secret to the clipboard for you to paste into the app. Once you have entered the secret into the app, it should return an OTP token for you to enter back into Equinix Metal. Click Enable App to complete the process.

Setting up MFA with an app

Using SMS - If you choose to use SMS, then the Enable MFA Using SMS panel appears. Enter a phone number that can receive SMS messages and click Send Code to send the initial OTP token to the number. Enter the token back into the Equinix Metal console. Click Enable SMS to complete the process.

Setting up MFA with SMS

Disabling MFA

To disable two-factor authentication, toggle MFA status, enter the current OTP code in the field, and click Turn Off MFA.

Disabling 2FA

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. These keys are added 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.

Copied code to clipboard