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

WSO2 Tenants API

The Tenants API from WSO2 — 3 operation(s) for tenants.

WSO2 Tenants API is one of 90 APIs that WSO2 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 3 paths, and defines 7 schemas. It is described by OpenAPI 3.0.1, at version v4.

Requests are made against a single base URL, https://apis.wso2.com/api/am/admin/v4.

3 operations 3 paths 7 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v4
Base URL
https://apis.wso2.com
Authentication
OAuth 2.0
Contact
License
Resource Areas
1

Authentication & Security 1

WSO2 Tenants API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2Security) using the password flow, exposing 41 scopes.

Paths & Operations 3

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

Tenants 3
GET
/tenant-info/{username}
Get Tenant Id of User
getTenantInfoByUsername 1 param → 200404406
GET
/custom-urls/{tenantDomain}
Get Custom URL Info of a Tenant Domain
getCustomUrlInfoByTenantDomain 1 param → 200404406
GET
/tenants
Get Tenants by State
3 params → 200404406

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Error (5 properties), Pagination (5 properties), CustomUrlInfo (4 properties), TenantInfo (3 properties). Each schema is shown below with its type and property counts.

TenantList
object
3 properties
ErrorListItem
object
2 properties 2 required
Pagination
object
5 properties
Error
object
5 properties 2 required
Tenant
object
2 properties
TenantInfo
object
The tenant information of the user
3 properties
CustomUrlInfo
object
The custom url information of the tenant domain
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wso2-tenants-api-openapi.yml Raw ↑

Other APIs WSO2 publishes across the network.

WSO2 Advanced Policy (Collection) API
WSO2 Advanced Policy (Individual) API
WSO2 AIServiceProvider API
WSO2 AIServiceProviders API
WSO2 Alert Subscriptions API
WSO2 Alerts API
WSO2 Api Artifact API
WSO2 API Categories API
WSO2 API Category (Collection) API
WSO2 API Category (Individual) API
WSO2 API Chat API
WSO2 API Documents API