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

APIGen Users API

Manage user profiles.

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

This API exposes 4 JSON Schema definitions.

Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification, a GitHub repository, a JSON-LD context, and 4 JSON Schemas.

This API exposes 2 operations across 1 path, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

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

2 operations 1 paths 3 schemas 1 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.apigen.com/v1
Authentication
HTTP Bearer, API Key
License
Resource Areas
1

Authentication & Security 2

APIGen Users API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as X-API-Key (apiKey). By default, every request must be authenticated.

Paths & Operations 2

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

Users 2

Manage user profiles.

GET
/users/me
APIGen Get Current User
getCurrentUser → 200401
PUT
/users/me
APIGen Update Current User
updateCurrentUser body → 200401422

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are User (6 properties), UserInput (2 properties), Error (1 property). Each schema is shown below with its type and property counts.

User
object
6 properties 5 required
UserInput
object
2 properties
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apigen-users-api-openapi.yml Raw ↑

Other APIs APIGen publishes across the network.

APIGen Connectors API
APIGen Deployments API
APIGen Endpoints API
APIGen Projects API
APIGen Schemas API
APIGen Tests API
APIGen Tokens API