AppList

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-app-list-schema.json",
  "title": "AppList",
  "x-generated": "2026-10-29",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ibm-api-connect-organization-application-api-openapi.yml#/components/schemas/AppList",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "total_results": {
      "type": "integer"
    },
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/App"
      }
    }
  },
  "$defs": {
    "APIAccessKey": {
      "type": "object",
      "properties": {
        "apiAccessKey": {
          "type": "string",
          "description": "API access key"
        },
        "expirationDate": {
          "type": "string",
          "description": "expiration date of the api key"
        },
        "expirationInterval": {
          "type": "string",
          "description": "expiration interval of the api key"
        }
      }
    },
    "App": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "type": "string",
          "readOnly": true,
          "enum": [
            "app"
          ]
        },
        "api_version": {
          "type": "string",
          "readOnly": true,
          "enum": [
            "2.0.0"
          ]
        },
        "id": {
          "type": "string",
          "readOnly": true
        },
        "name": {
          "type": "string",
          "maxLength": 255
        },
        "title": {
          "type": "string",
          "maxLength": 1023
        },
        "summary": {
          "type": "string",
          "maxLength": 65535
        },
        "state": {
          "type": "string",
          "enum": [
            "enabled",
            "disabled",
            "pending"
          ]
        },
        "lifecycle_state": {
          "type": "string",
          "enum": [
            "development",
            "production"
          ]
        },
        "lifecycle_state_pending": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "production"
          ]
        },
        "app_credential_urls": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uri"
          }
        },
        "client_id": {
          "type": "string"
        },
        "client_secret": {
          "type": "string"
        },
        "redirect_endpoints": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string",
            "format": "uri"
          }
        },
        "application_public_certificate_entry": {
          "type": "string"
        },
        "org_url": {
          "type": "string",
          "format": "uri"
        },
        "task_urls": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uri"
          }
        },
        "image_endpoint": {
          "type": [
            "string",
            "null"
          ],
          "format": "uri"
        },
        "application_type_url": {
          "type": "string",
          "format": "uri"
        },
        "api_urls": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string",
            "format": "uri"
          }
        },
        "access_tokens": {
          "$ref": "#/$defs/ApplicationToken"
        },
        "contact_emails": {
          "type": "array",
          "description": "list of email contacts",
          "items": {
            "type": "string"
          }
        },
        "custom_fields": {
          "type": "object",
          "description": "list of all custom fields",
          "additionalProperties": {
            "type": "object"
          }
        },
        "icon_byte_array": {
          "type": "string",
          "description": "application icon byte array"
        },
        "identifiers": {
          "type": "array",
          "description": "list of all application identifiers",
          "items": {
            "$ref": "#/$defs/ApplicationIdentifier"
          }
        },
        "js_origins": {
          "type": "array",
          "description": "list of all javascript origins",
          "items": {
            "type": "string"
          }
        },
        "primary_node": {
          "$ref": "#/$defs/Node"
        },
        "shell": {
          "type": "boolean"
        },
        "site_urls": {
          "type": "array",
          "description": "list of all site URLs",
          "items": {
            "type": "string"
          }
        },
        "subscription": {
          "type": "boolean"
        },
        "version": {
          "type": "string"
        },
        "rate_limit_notification_settings": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "enabled": {
              "type": "boolean"
            },
            "thresholds": {
              "type": "object",
              "properties": {
                "70": {
                  "type": "boolean"
                },
                "80": {
                  "type": "boolean"
                },
                "95": {
                  "type": "boolean"
                }
              }
            }
          }
        },
        "metadata": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "readOnly": true
        },
        "updated_at": {
          "type": "string",
          "format": "date-time",
          "readOnly": true
        },
        "url": {
          "type": "string",
          "readOnly": true,
          "format": "uri"
        }
      }
    },
    "ApplicationIdentifier": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "unique identifier of the application identifier"
        },
        "key": {
          "type": "string",
          "description": "identifier type"
        },
        "name": {
          "type": "string",
          "description": "name of the identifier"
        },
        "value": {
          "type": "array",
          "description": "list of identifier values",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "ApplicationToken": {
      "type": "object",
      "properties": {
        "apiAccessKey": {
          "$ref": "#/$defs/APIAccessKey"
        },
        "oauth2Token": {
          "$ref": "#/$defs/OAuth2Token"
        }
      }
    },
    "Node": {
      "type": "object",
      "properties": {
        "hostId": {
          "type": "string"
        },
        "replica": {
          "type": "integer",
          "minimum": 0,
          "maximum": 1000
        }
      }
    },
    "OAuth2Token": {
      "type": "object",
      "properties": {
        "clientId": {
          "type": "string",
          "description": "unique identifier of the oauth2 client"
        },
        "clientName": {
          "type": "string",
          "description": "the name of the client"
        },
        "clientSecret": {
          "type": "string",
          "description": "the client secret"
        },
        "expirationInterval": {
          "type": "string",
          "description": "the expiration interval"
        },
        "redirectUris": {
          "type": "array",
          "description": "list of redirect uris",
          "items": {
            "type": "string"
          }
        },
        "refreshCount": {
          "type": "string",
          "description": "number of times an access token can be refreshed"
        },
        "scopes": {
          "type": "array",
          "description": "the scopes associated with the client",
          "items": {
            "type": "string"
          }
        },
        "type": {
          "type": "string",
          "description": "type of the oauth2 client"
        }
      }
    }
  }
}