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

The users API from Wherobots — 4 operation(s) for users.

Wherobots users API is one of 34 APIs that Wherobots 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 4 operations across 4 paths, and defines 11 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.

4 operations 4 paths 11 schemas 3 GET1 POST

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 users 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 4

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

users 4
GET
/users/me
Get current user profile
getMe → 200400401403404409422500
POST
/users/me/role
Update current user role
updateRole → 200400401403404409422500
GET
/users/me/path-access
Verify access to an app path
verifyPathAccess 1 param → 200400401403404409422500
GET
/organization/{organization_id}/users/invitations
Get pending organization invitations
getOrganizationInvitations 1 param → 200400401403404409422500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are HumanPrincipal (8 properties), ServicePrincipal (8 properties), ErrorInfo (7 properties), Policy (7 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
ServicePrincipal
object
8 properties 7 required
ErrorBody
object
2 properties 2 required
Policy
object
7 properties 4 required
Customer
object
7 properties 6 required
Invitation
object
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wherobots-users-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