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

Wherobots user-management API

The user-management API from Wherobots — 2 operation(s) for user-management.

Wherobots user-management API is one of 34 APIs that Wherobots publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 2 paths, and defines 8 schemas. It is described by OpenAPI 3.1.0, at version 0.0.1.

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

3 operations 2 paths 8 schemas 1 DELETE2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.0.1
Base URL
https://api.cloud.wherobots.com
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Wherobots user-management API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerToken). An API key is passed in the header as X-API-Key (wherobotsApiKey).

  • wherobotsApiKey — A Wherobots-generated API key

Paths & Operations 3

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

user-management 3
GET
/user-management/{user_id}
Get user by ID
getUserById 1 param → 200400401403404409422500
DELETE
/user-management/{user_id}
Delete a user
deleteUser 1 param → 200400401403404409422500
GET
/user-management/by-email/{email}
Get users by email (partial match)
getUserByEmail 1 param → 200400401403404409422500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are HumanPrincipal (8 properties), ErrorInfo (7 properties), Policy (7 properties), Role-Output (6 properties). Each schema is shown below with its type and property counts.

Provider
string
ErrorInfo
object
7 properties 4 required
Role-Output
object
6 properties 6 required
HumanPrincipal
object
8 properties 7 required
ErrorClass
string
Effect
string
ErrorBody
object
2 properties 2 required
Policy
object
7 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wherobots-user-management-api-openapi.yml Raw ↑

Other APIs Wherobots publishes across the network.

Wherobots apikey API
Wherobots audit-log API
Wherobots catalogs API
Wherobots cloud-connections API
Wherobots coupon API
Wherobots environment-override--preset API
Wherobots environment-preset API
Wherobots files API
Wherobots Flags API
Wherobots foreign-catalog API
Wherobots Health API
Wherobots Is Super User API