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

The organization API from Wherobots — 25 operation(s) for organization.

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

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

This API exposes 27 operations across 25 paths, and defines 27 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.

27 operations 25 paths 27 schemas 3 DELETE9 GET1 PATCH9 POST5 PUT

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 organization 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 27

Across 25 paths, the API surfaces 27 operations — 3 DELETE, 9 GET, 1 PATCH, 9 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

organization 27
GET
/organization/quota/organization
List organization quotas
listQuotas → 200400401403404409422500
POST
/organization/coupon/redeem
Redeem an organization coupon
redeemCoupon body → 200400401403404409422500
GET
/organization/{organization_id}/users/invitations
Get pending organization invitations
getOrganizationInvitations 1 param → 200400401403404409422500
GET
/organization
Get current user's organization
getMyOrganization → 200400401403404409422500
DELETE
/organization
Delete the current organization
deleteMyOrganization → 200400401403404409422500
PATCH
/organization
Update current organization settings
updateMyOrganization body → 200400401403404409422500
POST
/organization/organization/invite
Invite users to the organization
inviteUsers body → 200400401403404409422500
DELETE
/organization/organization/invite/{email}
Cancel a pending invitation
cancelInvitation 1 param → 200400401403404409422500
POST
/organization/register
Register a new organization
organizationRegister 1 param body → 200400401403404409422500
POST
/organization/undelete
Restore a deleted organization
undeleteMyOrganization → 200400401403404409422500
POST
/organization/{organization_id}/register
Register a new user in an organization
userRegister 1 param → 200400401403404409422500
GET
/organization/{organization_id}/quotas
List quotas for an organization
listOrganizationQuotas 1 param → 200400401403404409422500
POST
/organization/{organization_id}/union-bootstrap
Bootstrap Union tenant for an org
unionBootstrap 2 params → 200400401403404409422500
GET
/organization/users/export
Export organization users as CSV
exportOrganizationUsers 1 param → 200400401403404409422500
PUT
/organization/users/{customer_id}/role
Change a user's role
switchCustomerRole 2 params → 200400401403404409422500
DELETE
/organization/users/{user_email}
Remove a user from the organization
deleteCustomer 1 param → 200400401403404409422500
POST
/organization/refresh-catalogs
Refresh current org catalogs
refreshCatalogs → 200400401403404409422500
GET
/organization/apikeys
List all API keys in the organization
getOrganizationApiKeys → 200400401403404409422500
PUT
/organization/default-environment-preset
Set default environment preset
setDefaultEnvironmentPreset 1 param → 200400401403404409422500
PUT
/organization/default-environment-override-preset
Set default environment override preset
setDefaultEnvironmentOverridePreset 1 param → 200400401403404409422500
PUT
/organization/default-region
Set the default compute region
setDefaultRegion 1 param → 200400401403404409422500
PUT
/organization/default-runtime
Set the default compute runtime
setDefaultRuntime 1 param → 200400401403404409422500
GET
/organization/by-name/{name}
Search organizations by name
getOrganizationsByName 1 param → 200400401403404409422500
GET
/organization/by-id/{org_id}
Get an organization by ID
getOrganization 1 param → 200400401403404409422500
GET
/organization/all
List all organizations for current user
getAllOrganizationsForUser → 200400401403404409422500
POST
/organization/create
Create a new organization
createOrganization body → 200400401403404409422500
POST
/organization/ensure-currentuser-humanprincipal
Ensure current user has a human principal
ensureCurrentUserHumanPrincipal body → 200400401403404409422500

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are Organization (25 properties), ApiKey (12 properties), OrgListingEntry (8 properties), HumanPrincipal (8 properties). Each schema is shown below with its type and property counts.

ErrorInfo
object
7 properties 4 required
QuotaType
string
WherobotsCloudFeature
string
FileStore
object
4 properties 4 required
HumanPrincipal
object
8 properties 7 required
Plan
string
Policy
object
7 properties 4 required
EnsureHumanPrincipalInput
object
1 property 1 required
OrganizationCreateInput
object
1 property 1 required
Provider
string
Role-Output
object
6 properties 6 required
ErrorBody
object
2 properties 2 required
Invitation
object
5 properties 4 required
OrganizationRegisterInput
object
1 property 1 required
StorageIntegrationDetails
object
7 properties 6 required
RuntimeId
string
Effect
string
OrganizationCustomer
object
6 properties 4 required
Organization
object
25 properties 15 required
Coupon
object
3 properties 3 required
ApiKey
object
12 properties 11 required
ErrorClass
string
OrgListingEntry
object
8 properties 6 required
OrganizationState
string
SamlSsoStatus
string
Body_redeemCoupon
object
2 properties 1 required
OrganizationUpdateInput
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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