{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/axway/main/json-schema/axway-session-info-schema.json",
  "title": "SessionInfo",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/axway-auth-api-openapi.yml#/components/schemas/SessionInfo",
  "type": "object",
  "properties": {
    "connect.sid": {
      "type": "string",
      "description": "Signed session ID."
    },
    "deviceAuthRequired": {
      "type": "string",
      "description": "Whether the user is still pending device authorization."
    },
    "email": {
      "type": "string",
      "description": "Email address of the signed-in user."
    },
    "entitlements": {
      "type": "object",
      "description": "Entitlements of the signed-in org."
    },
    "expiry": {
      "type": "string",
      "description": "Session expiry (if not accessed)."
    },
    "firstname": {
      "type": "string",
      "description": "First name of the signed-in user."
    },
    "from": {
      "type": "string",
      "description": "Type of client the session was initiated by, e.g. web/cli"
    },
    "guid": {
      "type": "string",
      "description": "GUID of the signed-in user."
    },
    "idp": {
      "type": "string",
      "description": "GUID of the Identity Provider used to authenticate the session."
    },
    "lastname": {
      "type": "string",
      "description": "Last name of the signed-in user."
    },
    "org": {
      "$ref": "#/$defs/Org"
    },
    "org_id": {
      "type": "string",
      "description": "org_id of the signed-in org."
    },
    "org_name": {
      "type": "string",
      "description": "Name of the signed-in org."
    },
    "orgs": {
      "type": "string",
      "description": "List of orgs that the user belongs to"
    },
    "provider_org": {
      "type": "object",
      "description": "Owning provider organization of the marketplace; included in consumer org sessions only",
      "properties": {
        "guid": {
          "type": "string",
          "format": "uuid",
          "description": "GUID identifier for the provider organization"
        },
        "name": {
          "type": "string",
          "description": "Name of the provider organization."
        },
        "org_id": {
          "type": "integer",
          "description": "Identifier for the provider organization"
        }
      }
    },
    "redirect": {
      "type": "string",
      "description": "URL to redirect to after signing in."
    },
    "role": {
      "type": "string",
      "description": "Current role of the user signed-in with this session.",
      "enum": [
        "administrator",
        "developer",
        "auditor",
        "consumer"
      ]
    },
    "roles": {
      "type": "array",
      "description": "List of roles the user is assigned on the signed-in org.",
      "items": {
        "type": "string",
        "description": "The id of the role.",
        "enum": [
          "administrator",
          "developer",
          "auditor",
          "consumer",
          "usage_reporter",
          "api_central_admin"
        ]
      }
    },
    "session": {
      "type": "string",
      "description": "Encoded session."
    },
    "sessionID": {
      "type": "string",
      "description": "The session ID."
    },
    "sid": {
      "type": "string",
      "description": "Signed session ID."
    },
    "teams": {
      "$ref": "#/$defs/UserTeams"
    },
    "user": {
      "$ref": "#/$defs/User"
    },
    "user_guid": {
      "type": "string",
      "description": "GUID of the signed-in user."
    },
    "username": {
      "type": "string",
      "description": "Username of the user this session belongs to."
    }
  },
  "$defs": {
    "DefaultFields": {
      "type": "object",
      "unevaluatedProperties": false,
      "properties": {
        "created": {
          "type": "string",
          "format": "date-time",
          "description": "Date created.",
          "readOnly": true
        },
        "created_by": {
          "type": "object",
          "description": "Creator user or client.",
          "readOnly": true,
          "properties": {
            "guid": {
              "type": "string",
              "description": "`guid` of the creator."
            },
            "type": {
              "type": "string",
              "description": "Type of the creator.",
              "enum": [
                "user",
                "client"
              ]
            }
          }
        },
        "updated": {
          "type": "string",
          "format": "date-time",
          "description": "Date last updated.",
          "readOnly": true
        }
      }
    },
    "Entitlements": {
      "type": "object",
      "description": "Subscription entitlements",
      "properties": {
        "id": {
          "type": "string",
          "title": "ID",
          "description": "An identifier for the plan"
        },
        "name": {
          "type": "string",
          "title": "Name",
          "description": "A name for the plan"
        },
        "ACT.Instances": {
          "type": "integer",
          "title": "Instances",
          "description": "Total allowed Instances."
        },
        "AgentSDK.Transactions": {
          "type": "integer",
          "title": "Third-party Gateway Traceability Agent Transactions",
          "description": "Third-party Gateway Traceability Agent Transactions per month. These are transactions instrumented using Agent SDK for vendors other than AWS, Azure, and Istio."
        },
        "provision_envs": {
          "type": "array",
          "title": "Provisioned Environments",
          "x-immutable": true,
          "x-deprecated": true,
          "items": {
            "type": "string",
            "enum": [
              "sandbox",
              "production"
            ]
          },
          "description": "Environments to provision in Integration Builder."
        },
        "transactions": {
          "type": "integer",
          "title": "Integration Builder Transactions",
          "x-deprecated": true,
          "description": "Integration Builder Transactions per month."
        },
        "AI.Transactions": {
          "type": "integer",
          "title": "AI Transactions",
          "description": "AI Transactions per month."
        },
        "AISuite.Cores": {
          "type": "integer",
          "title": "AI Suite Cores",
          "description": "Total allowed AI Suite Cores."
        },
        "AISuite.InputEvents": {
          "type": "integer",
          "title": "AI Suite Incoming Records",
          "description": "AI Suite Incoming Records per month."
        },
        "AISuite.Instances": {
          "type": "integer",
          "title": "AI Suite Rule Engine Instances",
          "description": "Total allowed AI Suite Rule Engine Instances."
        },
        "AISuite.Users": {
          "type": "integer",
          "title": "AI Suite Named Users",
          "description": "Total allowed AI Suite Named Users."
        },
        "AMPG.Transactions": {
          "type": "integer",
          "title": "Amplify Gateway Transactions",
          "description": "Amplify Gateway Transactions per month."
        },
        "AMPG.Volume": {
          "type": "number",
          "title": "Amplify Gateway Volume",
          "description": "Amplify Gateway transferred volume per month in GB."
        },
        "AMPI.Transactions": {
          "type": "integer",
          "title": "Integration Transactions",
          "description": "Integration Transactions per month."
        },
        "AMPI.Volume": {
          "type": "number",
          "title": "Data Volume",
          "description": " transferred volume per month in GB."
        },
        "AOB.Transactions": {
          "type": "integer",
          "title": "Open Banking API Transactions",
          "description": "Open Banking API Transactions per month."
        },
        "API.Transactions": {
          "type": "integer",
          "title": "API Transactions",
          "description": "API Transactions per month."
        },
        "APIB.Transactions": {
          "type": "integer",
          "title": "API Builder Transactions",
          "x-deprecated": true,
          "description": "API Builder Transactions per month."
        },
        "APIM.DRCores": {
          "type": "integer",
          "title": "DR Cores",
          "description": "Total allowed DR Cores."
        },
        "APIM.NonProdCores": {
          "type": "integer",
          "title": "Non-production Cores",
          "description": "Total allowed Non-production Cores."
        },
        "APIM.ProdCores": {
          "type": "integer",
          "title": "Production Cores",
          "description": "Total allowed Production Cores."
        },
        "APIM.Transactions": {
          "type": "integer",
          "title": "API Gateway Transactions",
          "description": "API Gateway Transactions per month."
        },
        "APIM.Volume": {
          "type": "number",
          "title": "API Gateway Outbound Volume",
          "description": "API Gateway transferred volume per month in GB."
        },
        "APIMG.Transactions": {
          "type": "integer",
          "title": "Amplify Istio Traceability Agent Transactions",
          "description": "Amplify Istio Traceability Agent Transactions per month."
        },
        "APIP.DRCores": {
          "type": "integer",
          "title": "DR Cores",
          "description": "Total allowed DR Cores."
        },
        "APIP.NonProdCores": {
          "type": "integer",
          "title": "Non-production Cores",
          "description": "Total allowed Non-production Cores."
        },
        "APIP.ProdCores": {
          "type": "integer",
          "title": "Production Cores",
          "description": "Total allowed Production Cores."
        },
        "Automator.CockpitEssential": {
          "type": "integer",
          "title": "Automator Cockpit Essential",
          "description": "Automator Cockpit Essential."
        },
        "Automator.CockpitPlus": {
          "type": "integer",
          "title": "Automator Cockpit Plus",
          "description": "Automator Cockpit Plus."
        },
        "Automator.Points": {
          "type": "integer",
          "title": "Automator Points",
          "description": "Automator Points."
        },
        "AWS.Transactions": {
          "type": "integer",
          "title": "AWS API Gateway Traceability Agent Transactions",
          "description": "AWS API Gateway Traceability Agent Transactions per month."
        },
        "Azure.Transactions": {
          "type": "integer",
          "title": "Azure API Gateway Traceability Agent Transactions",
          "description": "Azure API Gateway Traceability Agent Transactions per month."
        },
        "B2Bi.Cores": {
          "type": "integer",
          "title": "Cores",
          "description": "Total allowed DR cores."
        },
        "B2Bi.Messages": {
          "type": "integer",
          "title": "B2Bi Messages",
          "description": "B2Bi Messages per month."
        },
        "B2Bi.Partners": {
          "type": "integer",
          "title": "B2Bi Partners",
          "description": "B2Bi Partners per month."
        },
        "B2Bi.Volume": {
          "type": "number",
          "title": "B2Bi Volume",
          "description": "B2Bi transferred volume per month in GB."
        },
        "B2Bi.WTPartners": {
          "type": "integer",
          "title": "Webtrader Partners",
          "description": "Total allowed Webtrader Partners."
        },
        "BN.Volume": {
          "type": "integer",
          "title": "Axway Business Network Volume",
          "description": "Axway Business Network Volume per month in KiloCharacters."
        },
        "CFT.Cores": {
          "type": "integer",
          "title": "Cores",
          "description": "Total allowed Cores."
        },
        "CFT.MSUs": {
          "type": "integer",
          "title": "MSUs",
          "description": "Total allowed MSUs."
        },
        "CFT.Sessions": {
          "type": "integer",
          "title": "Sessions",
          "description": "Total allowed Sessions."
        },
        "CFT.Transfers": {
          "type": "integer",
          "title": "CFT File Transfers",
          "description": "CFT File Transfers per month."
        },
        "CSOS.CentralSigning": {
          "type": "boolean",
          "title": "CSOS Signing Instance",
          "description": "Allow access to CSOS Signing Instance feature."
        },
        "CSOS.Monitoring": {
          "type": "boolean",
          "title": "CSOS Monitoring",
          "description": "Allow access to CSOS Monitoring feature."
        },
        "CSOS.Orders": {
          "type": "integer",
          "title": "CSOS Orders",
          "description": "CSOS Orders per month."
        },
        "CSOS.Partners": {
          "type": "integer",
          "title": "CSOS Partners",
          "description": "Total allowed CSOS Partners."
        },
        "CSOS.Transformation": {
          "type": "boolean",
          "title": "CSOS Transformation",
          "description": "Allow access to CSOS Transformation feature."
        },
        "CSOS.Validation": {
          "type": "boolean",
          "title": "CSOS Validation Instance",
          "description": "Allow access to CSOS Validation Instance feature."
        },
        "DI.Dashboards": {
          "type": "integer",
          "title": "Axway Decision Insights Dashboards",
          "description": "Total allowed Axway Decision Insights Dashboards."
        },
        "DI.Users": {
          "type": "integer",
          "title": "Axway Decision Insights Named Users",
          "description": "Total allowed Axway Decision Insights Named Users."
        },
        "DS.Cores": {
          "type": "integer",
          "title": "Datastore Cores",
          "description": "Total allowed Datastore Cores."
        },
        "DS.Users": {
          "type": "integer",
          "title": "Datastore Client Users",
          "description": "Total allowed Datastore Client Users."
        },
        "DV.EnterpriseInstances": {
          "type": "integer",
          "title": "Desktop Validator Enterprise Instances",
          "description": "Total allowed Desktop Validator Enterprise Instances."
        },
        "DV.StandardInstances": {
          "type": "integer",
          "title": "Desktop Validator Standard Instances",
          "description": "Total allowed Desktop Validator Standard Instances."
        },
        "EBICSC.Channels": {
          "type": "integer",
          "title": "EBICS Client Channels",
          "description": "Total allowed EBICS Client Channels."
        },
        "EBICSCORP.Banks": {
          "type": "integer",
          "title": "Bank Connections Allowed",
          "description": "Total allowed EBICS Corporate bank connections."
        },
        "EBICSCORP.Treasurers": {
          "type": "integer",
          "title": "Treasurer Connections Allowed",
          "description": "Total allowed EBICS Corporate treasurer connections."
        },
        "EBICSG.Customers": {
          "type": "integer",
          "title": "EBICS Client Customers",
          "description": "Total allowed EBICS Client Customers."
        },
        "EBICSG.FileTransfers": {
          "type": "integer",
          "title": "EBICS Gateway File Transfers",
          "description": "EBICS Gateway File Transfers per month."
        },
        "EBICSG.Messages": {
          "type": "integer",
          "title": "EBICS Gateway Instant Payment Messages",
          "description": "EBICS Gateway Instant Payment Messages per month."
        },
        "EBICSG.Subscriptions": {
          "type": "integer",
          "title": "EBICS Gateway Subscriptions",
          "description": "Total allowed EBICS Gateway Subscriptions."
        },
        "EI.Archives": {
          "type": "integer",
          "title": "eInvoicing Archiving Transactions",
          "description": "eInvoicing Archiving Transactions per month."
        },
        "EI.Invoices": {
          "type": "integer",
          "title": "eInvoicing Transactions",
          "description": "eInvoicing Transactions per month."
        },
        "EI.OCRTransactions": {
          "type": "integer",
          "title": "OCR eInvoicing Transactions",
          "description": "OCR eInvoicing Transactions per month."
        },
        "EI.PeppolTransactions": {
          "type": "integer",
          "title": "PEPPOL Invoicing Transactions",
          "description": "PEPPOL Invoicing Transactions per month."
        },
        "EI.Transformations": {
          "type": "integer",
          "title": "eInvoicing Transformation Transactions",
          "description": "eInvoicing Transformation Transactions per month."
        },
        "EN.Environments": {
          "type": "integer",
          "title": "Connected Environments",
          "description": "Total allowed Connected Environments."
        },
        "EN.EnvironmentsNonProd": {
          "type": "integer",
          "title": "Connected Environments (Non-production)",
          "description": "Total allowed Connected Environments (Non-production)."
        },
        "EN.Services": {
          "type": "integer",
          "title": "API Services",
          "description": "Total allowed API Services."
        },
        "ESUB.ClientLicense": {
          "type": "integer",
          "title": "eSubmissions Client Licenses",
          "description": "Total allowed eSubmissions Client Licenses."
        },
        "ESUB.CommunityLicense": {
          "type": "integer",
          "title": "eSubmissions Community Licenses",
          "description": "Total allowed eSubmissions Community Licenses."
        },
        "ESUB.Messages": {
          "type": "integer",
          "title": "eSubmissions Messages",
          "description": "eSubmissions Messages per month."
        },
        "ESUB.Partners": {
          "type": "integer",
          "title": "eSubmissions (Non-Regulatory) Trading Partners",
          "description": "eSubmissions (Non-Regulatory) Trading Partners per month."
        },
        "ESUB.Regulatory": {
          "type": "integer",
          "title": "eSubmissions Regulatory Trading Partners",
          "description": "eSubmissions Regulatory Trading Partners per month."
        },
        "ESUB.T1": {
          "type": "integer",
          "title": "eSubmissions Client Tier 1",
          "description": "Total allowed eSubmissions Client Tier 1."
        },
        "ESUB.T2": {
          "type": "integer",
          "title": "eSubmissions Client Tier 2",
          "description": "Total allowed eSubmissions Client Tier 2."
        },
        "ESUB.T3": {
          "type": "integer",
          "title": "eSubmissions Client Tier 3",
          "description": "Total allowed eSubmissions Client Tier 3."
        },
        "ESUB.Volume": {
          "type": "number",
          "title": "eSubmissions Volume",
          "description": "eSubmissions transferred volume per month in GB."
        },
        "FAH.ApplicationConnectors": {
          "type": "integer",
          "title": "Financial Accounting Hub ApplicationConnectors",
          "description": "Total allowed Financial Accounting Hub ApplicationConnectors."
        },
        "FAH.Records": {
          "type": "integer",
          "title": "Financial Accounting Hub Records",
          "description": "Financial Accounting Hub Records per month."
        },
        "FAH.Users": {
          "type": "integer",
          "title": "Financial Accounting Hub Named Users",
          "description": "Total allowed Financial Accounting Hub Named Users."
        },
        "flows": {
          "type": "integer",
          "title": "Flow Manager Unit Flows",
          "description": "Flow Manager Unit Flows per month."
        },
        "FU.MultiPatternTransactions": {
          "type": "integer",
          "title": "Multi-Pattern Transactions",
          "description": "Multi-Pattern Transactions per month."
        },
        "HBS.Messages": {
          "type": "integer",
          "title": "Shared Usage Metric",
          "description": "Hybrid B2B Solution messages per month."
        },
        "Hub.Assets": {
          "type": "integer",
          "title": "Asset Catalog Assets",
          "description": "Total allowed Asset Catalog Assets."
        },
        "Hub.Marketplaces": {
          "type": "integer",
          "title": "Marketplaces",
          "description": "Total allowed Marketplaces."
        },
        "Hub.Subscriptions": {
          "type": "integer",
          "title": "Marketplace Subscriptions",
          "description": "Total allowed Marketplace Subscriptions."
        },
        "Hub.Transactions": {
          "type": "integer",
          "title": "Analytics Transactions",
          "description": "Analytics Transactions per month."
        },
        "INTP.Designers": {
          "type": "integer",
          "title": "Interplay Designers",
          "description": "Total allowed Interplay Designers."
        },
        "INTP.Instances": {
          "type": "integer",
          "title": "Interplay Instances",
          "description": "Total allowed Interplay Instances."
        },
        "PEPPOL.Transactions": {
          "type": "integer",
          "title": "PEPPOL Service Transactions",
          "description": "PEPPOL Service Transactions per month."
        },
        "SC.Instances": {
          "type": "integer",
          "title": "Secure Client Instances",
          "description": "Secure Client Instances."
        },
        "SC.Licenses": {
          "type": "array",
          "title": "Secure Client License Activation ID",
          "items": {
            "type": "string"
          },
          "description": "License Activation ID for Secure Client instances."
        },
        "SFC.Banks": {
          "type": "integer",
          "title": "Secure Financial Client Banks",
          "description": "Total allowed Secure Financial Client Banks."
        },
        "SFC.Partners": {
          "type": "integer",
          "title": "Secure Financial Client Connection Partners",
          "description": "Total allowed Secure Financial Client Connection Partners."
        },
        "SFC.Treasurers": {
          "type": "integer",
          "title": "Secure Financial Client Treasurers",
          "description": "Total allowed Secure Financial Client Treasurers."
        },
        "ST.ActiveUsers": {
          "type": "integer",
          "title": "Connections",
          "description": "Total allowed Connections."
        },
        "ST.Connections": {
          "type": "integer",
          "title": "Connections",
          "description": "Total allowed Connections."
        },
        "ST.Cores": {
          "type": "integer",
          "title": "Cores",
          "description": "Total allowed Cores."
        },
        "ST.Instances": {
          "type": "integer",
          "title": "Production Instances",
          "description": "Total allowed Production Instances."
        },
        "ST.Sessions": {
          "type": "integer",
          "title": "Sessions",
          "description": "Total allowed Sessions."
        },
        "ST.Transfers": {
          "type": "integer",
          "title": "File Transfers",
          "description": "File Transfers per month."
        },
        "ST.TransfersIn": {
          "type": "integer",
          "title": "Transfers In",
          "description": "Transfers In per month."
        },
        "ST.TransfersOut": {
          "type": "integer",
          "title": "Transfers Out",
          "description": "Transfers Out per month."
        },
        "ST.Volume": {
          "type": "number",
          "title": "Incoming Data Volume",
          "description": "Transferred data volume per month in GB."
        },
        "STL.Applications": {
          "type": "integer",
          "title": "Monitored Applications",
          "description": "Total allowed Monitored Applications."
        },
        "STL.CPUs": {
          "type": "integer",
          "title": "CPUs",
          "description": "Total allowed CPUs."
        },
        "STL.Users": {
          "type": "integer",
          "title": "Users",
          "description": "Total allowed Users."
        },
        "Streams.Events": {
          "type": "integer",
          "title": "Streams Events",
          "description": "Streams Events per month."
        },
        "Streams.Volume": {
          "type": "number",
          "title": "Streams Volume",
          "description": "Streams transferred volume per month in GB."
        },
        "SV.Users": {
          "type": "integer",
          "title": "Server Validator Users",
          "description": "Total allowed Server Validator Users."
        },
        "TNT.Compliance": {
          "type": "array",
          "title": "Compliance Module",
          "items": {
            "type": "string",
            "enum": [
              "EU",
              "SA",
              "UAE"
            ]
          }
        },
        "TNT.Lines": {
          "type": "integer",
          "title": "Manufactoring/Distributor Lines",
          "description": "Total allowed Manufactoring/Distributor Lines."
        },
        "TNT.Packs": {
          "type": "integer",
          "title": "Unit Packs",
          "description": "Total allowed Unit Packs."
        },
        "TNT.Routing": {
          "type": "boolean",
          "title": "DSCSA Routing Service"
        },
        "TNT.SerialNumbers": {
          "type": "integer",
          "title": "Track & Trace Serial Numbers",
          "description": "Track & Trace Serial Numbers."
        },
        "Traceable.Discovery": {
          "type": "integer",
          "title": "Traceable API Discovery",
          "description": "Total allowed Traceable API Discovery."
        },
        "Traceable.SecurityTesting": {
          "type": "boolean",
          "title": "Traceable API Security Testing",
          "description": "Allow access to Traceable API Security Testing feature."
        },
        "TSIM.Cores": {
          "type": "integer",
          "title": "Cores",
          "description": "Total allowed DR cores."
        },
        "TSIM.Messages": {
          "type": "integer",
          "title": "TSIM Messages",
          "description": "TSIM Messages per month."
        },
        "TSIM.Partners": {
          "type": "integer",
          "title": "TSIM Partner Relations",
          "description": "TSIM allowed partners per month."
        },
        "TSIM.Users": {
          "type": "integer",
          "title": "ENGDAT Users",
          "description": "Total allowed ENGDAT Users."
        },
        "TSIM.Volume": {
          "type": "number",
          "title": "TSIM Volume",
          "description": "TSIM transferred volume per month in GB."
        },
        "VA.Policies": {
          "type": "integer",
          "title": "Policies",
          "description": "Total allowed Policies."
        },
        "VA.Repeaters": {
          "type": "integer",
          "title": "Repeater Instances",
          "description": "Total allowed Repeater Instances."
        },
        "VA.Responsers": {
          "type": "integer",
          "title": "Responser Instances",
          "description": "Total allowed Responser Instances."
        },
        "VRS.Transactions": {
          "type": "integer",
          "title": "Axway VRS Solution Transactions",
          "description": "Axway VRS Solution Transactions per month."
        },
        "WebEDI.Users": {
          "type": "integer",
          "title": "WebEDI Portal Users",
          "description": "Total allowed WebEDI Portal Users."
        },
        "WebEDI.Volume": {
          "type": "number",
          "title": "WebEDI Portal Volume",
          "description": "WebEDI Portal transferred volume per month in GB."
        },
        "APIConnect.Transactions": {
          "type": "integer",
          "title": "IBM APIConnect Traceability Agent Transactions",
          "description": "IBM APIConnect Traceability Agent Transactions per month."
        },
        "Apigee.Transactions": {
          "type": "integer",
          "title": "Apigee Traceability Agent Transactions",
          "description": "Apigee Traceability Agent Transactions per month."
        },
        "APIMAgent.Transactions": {
          "type": "integer",
          "title": "Axway Gateway Traceability Agent Transactions",
          "description": "Axway Gateway Traceability Agent Transactions per month."
        },
        "Kafka.Transactions": {
          "type": "integer",
          "title": "Kafka Traceability Agent Transactions",
          "description": "Kafka Traceability Agent Transactions per month."
        },
        "SAPAPIPortal.Transactions": {
          "type": "integer",
          "title": "SAP API Portal Traceability Agent Transactions",
          "description": "SAP API Portal Traceability Agent Transactions per month."
        },
        "Sensedia.Transactions": {
          "type": "integer",
          "title": "Sensedia Agent Transactions",
          "description": "Sensedia Agent Transactions per month."
        },
        "Tokens": {
          "type": "integer",
          "title": "Tokens",
          "description": "Amplify API Management Platform offering tokens per month."
        },
        "Volume": {
          "type": "integer",
          "title": "Volume",
          "description": "Amplify API Management Platform offering transaction volume per month."
        },
        "WebMethods.Transactions": {
          "type": "integer",
          "title": "Software AG webMethods Agent Transactions",
          "description": "Software AG webMethods Agent Transactions per month."
        },
        "WSO2.Transactions": {
          "type": "integer",
          "title": "WSO2 Traceability Agent Transactions",
          "description": "WSO2 Traceability Agent Transactions per month."
        },
        "AIIntegration": {
          "type": "boolean",
          "title": "AI Integration",
          "description": "Allow access to AI Integration feature."
        },
        "APICompliance": {
          "type": "boolean",
          "title": "API Compliance",
          "description": "Allow access to API Compliance feature."
        },
        "APIMocking": {
          "type": "boolean",
          "title": "API Mocking",
          "description": "Allow access to API Mocking feature."
        },
        "catalog": {
          "type": "boolean",
          "title": "Unified Catalog Access",
          "description": "Allow access to Unified Catalog."
        },
        "daysDataRetained": {
          "type": "integer",
          "title": "Data Retention",
          "description": "How long analytics events are kept in days."
        },
        "FIPS": {
          "type": "boolean",
          "title": "FIPS"
        },
        "idp": {
          "type": "boolean",
          "title": "External Identity Provider",
          "description": "Allow configuration of an external identity provider for authentication."
        },
        "partners": {
          "type": "array",
          "title": "Partners",
          "x-immutable": [
            "AEM",
            "AMP",
            "APIM",
            "APIMG",
            "AWS",
            "Azure",
            "Bundle",
            "EN",
            "Hub",
            "Streams",
            "ai",
            "ars",
            "fc",
            "ib"
          ],
          "items": {
            "type": "string",
            "enum": [
              "aca",
              "analytics",
              "api_central"
            ]
          },
          "description": "Partners the organization has access to."
        },
        "public_provider": {
          "type": "boolean",
          "title": "Public Marketplace",
          "description": "Allow public Marketplace features including vanity URL, unauthorized access, consumer org support, homepage content, and paid plans."
        },
        "retention": {
          "type": "integer",
          "title": "Analytics Event Retention",
          "description": "Length of time analytics events are kept in days."
        },
        "retentionTransactions": {
          "type": "integer",
          "title": "Transaction Event Retention",
          "description": "Length of time transaction events are kept in days."
        }
      }
    },
    "Org": {
      "type": "object",
      "required": [
        "active",
        "guid",
        "name",
        "org_id",
        "region",
        "subscriptions",
        "users"
      ],
      "unevaluatedProperties": false,
      "allOf": [
        {
          "$ref": "#/$defs/DefaultFields"
        }
      ],
      "properties": {
        "_id": {
          "type": "string",
          "description": "The id of the organization.",
          "readOnly": true,
          "deprecated": true
        },
        "account_id": {
          "type": "integer",
          "description": "Account ID of the organization.",
          "minimum": 10000,
          "maximum": 999999
        },
        "active": {
          "type": "boolean",
          "description": "Active state of the organization. Organizations become inactive after passing their end date.",
          "default": true
        },
        "analytics": {
          "type": "object",
          "description": "Analytics details for the organization",
          "additionalProperties": false,
          "properties": {
            "token": {
              "type": "string",
              "description": "Token used to identify the organization."
            }
          }
        },
        "api_central": {
          "type": "object",
          "description": "Engage provision status",
          "readOnly": true
        },
        "branding": {
          "type": "object",
          "description": "Organization branding.",
          "additionalProperties": false,
          "properties": {
            "logo": {
              "type": "string",
              "description": "Logo image of the company."
            }
          }
        },
        "consumer_id": {
          "type": "string",
          "description": "Mapped ID of the consumer org from the configured Identity Provider."
        },
        "created_by": {
          "type": "object",
          "description": "Details of the user that created the organization.",
          "unevaluatedProperties": false,
          "properties": {
            "client_id": {
              "type": "string",
              "description": "The client_id of the client that created the organization.",
              "readOnly": true
            },
            "email": {
              "type": "string",
              "format": "email",
              "description": "Email address of the user that created the organization.",
              "readOnly": true
            },
            "name": {
              "type": "string",
              "description": "The name of the user or client that created the organization.",
              "readOnly": true
            }
          }
        },
        "entitlements": {
          "type": "object",
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/$defs/Entitlements"
            }
          ]
        },
        "guid": {
          "type": "string",
          "format": "uuid",
          "description": "GUID identifier for the organization"
        },
        "help_menu": {
          "type": "object",
          "description": "Contents of the help menu displayed in the navigation bar.",
          "default": {
            "enabled": false
          },
          "additionalProperties": false,
          "properties": {
            "enabled": {
              "type": "boolean",
              "description": "Whether the custom help menu is enabled.",
              "default": false
            },
            "defaults": {
              "type": "boolean",
              "description": "Whether to include the default items."
            },
            "icon": {
              "type": "string",
              "description": "Icon displayed in the navigation bar to show the help menu."
            },
            "items": {
              "type": "array",
              "description": "Custom help menu shown in the navigation bar.",
              "items": {
                "type": "object",
                "required": [
                  "text",
                  "type",
                  "url"
                ],
                "unevaluatedProperties": false,
                "oneOf": [
                  {
                    "type": "object",
                    "properties": {
                      "type": {
                        "type": "string",
                        "enum": [
                          "url"
                        ]
                      },
                      "url": {
                        "type": "string",
                        "format": "url",
                        "description": "URL for the link."
                      }
                    }
                  },
                  {
                    "type": "object",
                    "properties": {
                      "type": {
                        "type": "string",
                        "enum": [
                          "document"
                        ]
                      },
                      "url": {
                        "type": "string",
                        "description": "Document resource guid"
                      }
                    }
                  }
                ],
                "properties": {
                  "icon": {
                    "type": "string",
                    "description": "Icon displayed in the menu for the item."
                  },
                  "new_tab": {
                    "type": "boolean",
                    "description": "Whether the link opens in a new tab."
                  },
                  "provider_guid": {
                    "type": "string",
                    "description": "The GUID of the provider a document url is for"
                  },
                  "text": {
                    "type": "string",
                    "description": "Label for the link.",
                    "x-no-tags": true
                  },
                  "type": {
                    "type": "string",
                    "description": "Type of the link.",
                    "enum": [
                      "document",
                      "url"
                    ]
                  },
                  "url": {
                    "type": "string",
                    "description": "URL, relative path, or document resource guid for the link."
                  }
                }
              }
            }
          }
        },
        "last_login": {
          "type": "string",
          "format": "date-time",
          "description": "When the most recent session was created in the organization.",
          "readOnly": true
        },
        "logged_in_count": {
          "type": "number",
          "description": "How many session are been created in the organization.",
          "readOnly": true
        },
        "name": {
          "type": "string",
          "description": "Name of the organization.",
          "minLength": 2,
          "maxLength": 64,
          "x-no-tags": true
        },
        "onboarding": {
          "type": "object",
          "description": "Onboarding data for consumer org.",
          "maxProperties": 50,
          "writeOnly": true,
          "patternProperties": {
            "[\\w-]{21}": {
              "type": [
                "string",
                "number",
                "boolean",
                "array"
              ],
              "description": "Onboarding data field value.",
              "items": {
                "type": "string",
                "description": "Onboarding data field multi-select option value."
              }
            }
          }
        },
        "onboarding_required": {
          "type": "array",
          "readOnly": true,
          "items": {
            "type": "string",
            "pattern": "[\\w-]{21}"
          }
        },
        "org_id": {
          "type": "integer",
          "description": "Identifier for the organization"
        },
        "origin": {
          "type": [
            "string",
            "null"
          ],
          "description": "Source from which the organization creation originated.",
          "enum": [
            "360",
            "sfdc",
            "signup"
          ]
        },
        "pending": {
          "type": "boolean",
          "description": "Whether the organization is pending approval for a provider organization administator."
        },
        "provider_guid": {
          "type": "string",
          "format": "uuid",
          "description": "GUID identifier of the owning provider if the organization is a consumer of a marketplace."
        },
        "region": {
          "type": "string",
          "description": "The data residency region of the organization.",
          "default": "US",
          "enum": [
            "US",
            "EU",
            "AP"
          ]
        },
        "security": {
          "type": "object",
          "description": "Security settings for the organization.",
          "additionalProperties": false,
          "properties": {
            "access_controls": {
              "type": "object",
              "description": "Developer visibility controls.",
              "additionalProperties": false,
              "properties": {
                "enviroments": {
                  "type": "number",
                  "description": "Developer access to environments. 0 - Developers cannot view environments, 1 - Developer may view all environemnts.",
                  "enum": [
                    0,
                    1
                  ]
                },
                "service_accounts": {
                  "type": "number",
                  "description": "Developer access to service accounts. 0 - Developers cannot view service accounts, 1 - Developers may view service accounts in their teams, 2 - Developer may view all service accounts.",
                  "enum": [
                    0,
                    1,
                    2
                  ]
                },
                "usage": {
                  "type": "number",
                  "description": "Developer access to usage. 0 - Developers cannot view usage, 1 - Developer may view all usage.",
                  "enum": [
                    0,
                    1
                  ]
                },
                "users": {
                  "type": "number",
                  "description": "Developer access to users.0 - Developers cannot view users, 1 - Developers may view administrators and users in their teams, 2 - Developer may view all users.",
                  "enum": [
                    0,
                    1,
                    2
                  ]
                }
              }
            },
            "allow_tooling": {
              "type": "boolean",
              "description": "Grant access using tooling credentials"
            },
            "disable_analytics": {
              "type": "boolean",
              "description": "Opt out from third-party support services."
            },
            "password_policy": {
              "$ref": "#/$defs/PasswordPolicy"
            },
            "redact_personal": {
              "type": "boolean",
              "description": "Personal information like email addresses will be masked in UI.",
              "default": false
            }
          }
        },
        "subscriptions": {
          "type": "array",
          "default": [],
          "items": {
            "$ref": "#/$defs/Subscription"
          }
        },
        "support_access_code": {
          "type": "integer",
          "description": "Support Access Code for the org.",
          "minimum": 10000,
          "maximum": 999999
        },
        "users": {
          "type": "array",
          "description": "List of users that are members of the organization.",
          "default": [],
          "items": {
            "type": "object",
            "required": [
              "guid",
              "roles"
            ],
            "additionalProperties": false,
            "properties": {
              "guid": {
                "type": "string",
                "format": "uuid",
                "description": "GUID of the user."
              },
              "idp": {
                "type": "string",
                "description": "GUID of the Identity Provider the user is required to authenticate with to access the organization."
              },
              "primary": {
                "type": "boolean",
                "description": "Whether the user is the primary contact for the organization."
              },
              "roles": {
                "type": "array",
                "description": "Roles within the organization.",
                "items": {
                  "type": "string",
                  "enum": [
                    "administrator",
                    "developer",
                    "auditor",
                    "consumer",
                    "usage_reporter",
                    "api_central_admin"
                  ]
                }
              }
            }
          }
        }
      }
    },
    "PasswordPolicy": {
      "type": "object",
      "description": "Password policy",
      "properties": {
        "length": {
          "type": "integer",
          "minimum": 9,
          "maximum": 127,
          "default": 8
        },
        "max_length": {
          "type": "integer",
          "minimum": 9,
          "maximum": 127,
          "default": 128
        },
        "lower": {
          "type": "integer",
          "minimum": 1
        },
        "upper": {
          "type": "integer",
          "minimum": 1
        },
        "special": {
          "type": "integer",
          "minimum": 1
        },
        "digit": {
          "type": "integer",
          "minimum": 1
        },
        "lockout": {
          "type": "integer",
          "minimum": 1,
          "maximum": 4,
          "default": 5
        },
        "renewal": {
          "type": "integer",
          "minimum": 1
        },
        "history": {
          "type": "integer",
          "minimum": 1,
          "maximum": 10
        }
      }
    },
    "Subscription": {
      "type": "object",
      "description": "Organization entitlements",
      "required": [
        "id",
        "product",
        "plan",
        "entitlements"
      ],
      "additionalProperties": false,
      "properties": {
        "end_date": {
          "type": "string",
          "format": "date-time",
          "description": "When the subscription is active to."
        },
        "entitlements": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "key",
              "value"
            ],
            "properties": {
              "key": {
                "type": "string",
                "description": "Entitlement key."
              },
              "value": {
                "oneOf": [
                  {
                    "type": "boolean",
                    "description": "Boolean entitlement, granting access to a feature of capability."
                  },
                  {
                    "type": "integer",
                    "description": "Integer entitlement value, granting quota of allow transactions or requests per month.",
                    "maximum": 9999999999999
                  },
                  {
                    "type": "number",
                    "description": "Numeric entitlement value, granting allow volumes of network throughput or storage.",
                    "maximum": 9999999999999
                  },
                  {
                    "type": "array",
                    "description": "Set entitlement, listing provisioned service or environment availability.",
                    "items": {
                      "type": "string",
                      "description": "Service or environment key."
                    }
                  }
                ]
              }
            }
          }
        },
        "governance": {
          "type": "string",
          "description": "Governance model for the subscription.",
          "enum": [
            "SaaS",
            "Customer Managed",
            "Axway Managed"
          ]
        },
        "id": {
          "type": "string",
          "description": "Identifier for the subscription."
        },
        "opportunity_id": {
          "type": "number",
          "description": "Opportunity ID associated with the subscription.",
          "minimum": 10000,
          "maximum": 999999
        },
        "plan": {
          "type": "string",
          "description": "Which plan the subscription is for."
        },
        "product": {
          "type": "string",
          "description": "Name to identify the product, e.g. APIM, B2Bi."
        },
        "product_name": {
          "type": "string",
          "description": "Official product name.",
          "readOnly": true
        },
        "source": {
          "type": "string",
          "description": "Source of this subscription.",
          "enum": [
            "API",
            "UI",
            "Platform",
            "Billing"
          ]
        },
        "start_date": {
          "type": "string",
          "format": "date-time",
          "description": "When the subscription is active from."
        },
        "tier": {
          "type": "string",
          "description": "Whether the subscription is a trial or paid for.",
          "enum": [
            "paid",
            "trial",
            "free"
          ]
        }
      }
    },
    "User": {
      "type": "object",
      "required": [
        "activated",
        "active",
        "email",
        "firstname",
        "guid",
        "lastname",
        "user_id"
      ],
      "unevaluatedProperties": false,
      "properties": {
        "_id": {
          "type": "string",
          "description": "ID of the user.",
          "readOnly": true,
          "deprecated": true
        },
        "activated": {
          "type": "boolean",
          "description": "Whether the user has activated.",
          "default": false
        },
        "active": {
          "type": "boolean",
          "description": "Whether the user is active.",
          "default": false
        },
        "authenticator_enabled": {
          "type": "boolean",
          "description": "Whether an authenticator app is enavled for the user."
        },
        "created": {
          "$ref": "#/$defs/created"
        },
        "date_activated": {
          "type": "string",
          "format": "date-time",
          "description": "When the user activated."
        },
        "default_org": {
          "type": "number",
          "description": "The org_id for the organization to use when last_login is set to default."
        },
        "email": {
          "type": "string",
          "format": "email",
          "description": "Email address of the user.",
          "maxLength": 217
        },
        "external": {
          "type": "boolean",
          "description": "Whether the user is external."
        },
        "firstname": {
          "type": "string",
          "description": "First name of the user.",
          "default": "",
          "maxLength": 50,
          "x-allow-empty": true,
          "x-no-tags": true
        },
        "guid": {
          "type": "string",
          "description": "GUID of the user."
        },
        "invited": {
          "type": "string",
          "format": "date-time",
          "description": "When the user was most recently invited. Only set for not-yet-activated users."
        },
        "last_logged_in_org": {
          "type": "number",
          "description": "The org_id of the organization the user last signed into."
        },
        "last_login": {
          "type": "string",
          "format": "date-time",
          "description": "When the user last signed in."
        },
        "lastname": {
          "type": "string",
          "description": "Last name of the user.",
          "default": "",
          "maxLength": 50,
          "x-allow-empty": true,
          "x-no-tags": true
        },
        "locale": {
          "type": "string",
          "description": "Preferred display language for the user.",
          "enum": [
            "en-US",
            "fr-FR",
            "de-DE",
            "pt-BR"
          ]
        },
        "logged_in_count": {
          "type": "number",
          "description": "The number of times the user has signed in."
        },
        "logged_in_from_cli": {
          "type": "boolean",
          "description": "Whether the user has previously signed in from cli."
        },
        "logged_in_from_other": {
          "type": "boolean",
          "description": "Whether the user has previously signed in from an unknown source."
        },
        "logged_in_from_studio": {
          "type": "boolean",
          "description": "Whether the user has previously signed in from studio."
        },
        "logged_in_from_web": {
          "type": "boolean",
          "description": "Whether the user has previously signed in from web."
        },
        "login_org": {
          "type": "string",
          "description": "Which organization is used when the user signs in.",
          "enum": [
            "last_logged",
            "default",
            "ask"
          ]
        },
        "mfa": {
          "type": "boolean",
          "description": "Whether multi-factor authentication is enabled for the user."
        },
        "oauth": {
          "type": "array",
          "description": "Which social login services are associated with the user.",
          "items": {
            "type": "string",
            "description": "The name of the social login service"
          }
        },
        "password_updated": {
          "type": "string",
          "format": "date-time",
          "description": "Date the password was last updated"
        },
        "prefs": {
          "type": "object",
          "description": "User preferences."
        },
        "provider_guid": {
          "type": "string",
          "format": "uuid",
          "description": "GUID identifier of the owning provider if a consumer of a marketplace."
        },
        "terms_updated": {
          "type": "string",
          "format": "date-time",
          "description": "Date the user accepted terms & conditions."
        },
        "timezone": {
          "type": "string",
          "description": "The timezone used to display dates for the user."
        },
        "updated": {
          "$ref": "#/$defs/updated"
        },
        "user_id": {
          "type": "number"
        },
        "username": {
          "type": "string"
        }
      }
    },
    "UserTeams": {
      "type": "array",
      "description": "List of teams the user belongs to.",
      "items": {
        "type": "object",
        "description": "Teams a user belongs to.",
        "properties": {
          "default": {
            "$ref": "#/$defs/default"
          },
          "guid": {
            "$ref": "#/$defs/guid"
          },
          "name": {
            "$ref": "#/$defs/name"
          },
          "roles": {
            "type": "array",
            "description": "A list of roles the user has in the team",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "$ref": "#/$defs/id"
                },
                "name": {
                  "$ref": "#/$defs/name"
                }
              }
            }
          },
          "tags": {
            "$ref": "#/$defs/tags"
          }
        }
      }
    }
  }
}