Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Equinix Users API

User Management

Equinix Users API is one of 74 APIs that Equinix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 5 paths, and defines 10 schemas. It is described by OpenAPI 3.0.1, at version 1.2.

Requests are made against a single base URL, https://api.equinix.com.

7 operations 5 paths 10 schemas 5 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.2
Base URL
https://api.equinix.com
Terms of Service
Resource Areas
1

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 5 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 7

User Management

GET
/invitations
Retrieve current user invitations
findInvitations 3 params → 200401403404
GET
/user
Retrieve the current user
findCurrentUser 2 params → 200401
PUT
/user
Update the current user
updateCurrentUser 2 params body → 200401422
GET
/users
Retrieve all users
findUsers 4 params → 200401
POST
/users
Create a user
createUser 2 params body → 201401422
GET
/users/{id}
Retrieve a user
findUserById 3 params → 200401403404
GET
/users/{id}/customdata
Retrieve the custom metadata of a user
findUserCustomdata 1 param → 200401403404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are User (22 properties), UserCreateInput (17 properties), Meta (8 properties), Membership (7 properties). Each schema is shown below with its type and property counts.

Membership
object
7 properties
User
object
22 properties
UserCreateInput
object
17 properties 3 required
UserUpdateInput
object
6 properties
Meta
object
8 properties
Error
object
Error responses are included with 4xx and 5xx HTTP responses from the API service. Either "error" or "errors" will be set.
2 properties
InvitationList
object
1 property
EmailInput
object
2 properties 1 required
UserList
object
2 properties
Href
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

equinix-users-api-openapi.yml Raw ↑

Other APIs Equinix publishes across the network.

Equinix Agent Templates API
Equinix Agents API
Equinix Authentication API
Equinix availability API
Equinix Batches API
Equinix BGP API
Equinix Capacity API
Equinix Cloud Events API
Equinix Cloud Routers API
Equinix Company Profiles API
Equinix Connections API
Equinix Console Log Details API