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

Express Gateway Users API

The Users API from Express Gateway — 3 operation(s) for users.

Express Gateway Users API is one of 5 APIs that Express Gateway 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.

This API exposes 6 operations across 3 paths. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, http://localhost:9876.

6 operations 3 paths 0 schemas 1 DELETE2 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Server
http://localhost:9876
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Express Gateway Users API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (KeyAuth). By default, every request must be authenticated, though some operations may also be called without credentials.

  • KeyAuth — When the Admin API is fronted by Express Gateway with key-auth, send "Authorization: apikey {keyId}:{keySecret}".

Paths & Operations 6

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

Users 6
GET
/users
List users
listUsers → 200
POST
/users
Create a user
createUser body → 201
GET
/users/{id}
Get a user
getUser 1 param → 200
PUT
/users/{id}
Update a user
updateUser 1 param body → 204
DELETE
/users/{id}
Delete a user
deleteUser 1 param → 204
PUT
/users/{id}/status
Activate or deactivate a user
setUserStatus 1 param body → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

express-gateway-users-api-openapi.yml Raw ↑

Other APIs Express Gateway publishes across the network.

Express Gateway
Express Gateway Apps API
Express Gateway Credentials API
Express Gateway Scopes API