WSO2 · Schema

Organization

Organization schema from WSO2 API Manager

API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Properties

Name Type Description
organizationId string UUID of the organization.
externalOrganizationId string External id of the organization.
parentOrganizationId string UUID of the parent organization if there is any.
displayName string
description string
View JSON Schema on GitHub

JSON Schema

admin-api-organization-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-schema/admin-api-organization-schema.json",
  "title": "Organization",
  "description": "Organization schema from WSO2 API Manager",
  "required": [
    "externalOrganizationId"
  ],
  "type": "object",
  "properties": {
    "organizationId": {
      "type": "string",
      "example": "ece92bdc-e1e6-325c-b6f4-656208a041e9",
      "readOnly": true,
      "description": "UUID of the organization.\n"
    },
    "externalOrganizationId": {
      "type": "string",
      "example": "ece92bdc-e1e6-325c-b6f4-656208a041e9",
      "description": "External id of the organization.\n"
    },
    "parentOrganizationId": {
      "type": "string",
      "readOnly": true,
      "example": "ece92bdc-e1e6-325c-b6f4-656208a041e9",
      "description": "UUID of the parent organization if there is any.\n"
    },
    "displayName": {
      "maxLength": 255,
      "minLength": 1,
      "type": "string",
      "example": "My Organization"
    },
    "description": {
      "maxLength": 1023,
      "type": "string",
      "example": "My Organization Description"
    }
  }
}