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 Credentials API

The Credentials API from Express Gateway — 6 operation(s) for credentials.

Express Gateway Credentials 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 Credentials. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 6 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.

8 operations 6 paths 0 schemas 1 DELETE3 GET1 POST3 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 Credentials 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 8

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

Credentials 8
GET
/credentials
List credentials
listCredentials → 200
POST
/credentials
Create a credential
createCredential body → 201
GET
/credentials/{consumerId}
List credentials for a consumer (user or app)
listConsumerCredentials 1 param → 200
GET
/credentials/{type}/{id}
Get a credential by type and id
getCredential 2 params → 200
PUT
/credentials/{type}/{id}/status
Activate or deactivate a credential
setCredentialStatus 2 params body → 204
PUT
/credentials/{type}/{id}/scopes
Set all scopes on a credential
setCredentialScopes 2 params body → 204
PUT
/credentials/{type}/{id}/scopes/{scope}
Add a scope to a credential
addCredentialScope 3 params → 204
DELETE
/credentials/{type}/{id}/scopes/{scope}
Remove a scope from a credential
removeCredentialScope 3 params → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Express Gateway publishes across the network.

Express Gateway
Express Gateway Apps API
Express Gateway Scopes API
Express Gateway Users API