AppPost

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/1password/json-schema/1password-app-post-schema.json",
  "title": "AppPost",
  "description": "The details used to create an application",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/1password-applications-api-openapi.yml#/components/schemas/AppPost",
  "type": "object",
  "properties": {
    "globalAppId": {
      "type": [
        "string",
        "null"
      ],
      "description": "The ID of the application in the global application catalog. Provide this or globalAppName (exactly one)."
    },
    "globalAppName": {
      "type": [
        "string",
        "null"
      ],
      "description": "The name of the application in the global application catalog. Provide this or globalAppId (exactly one)."
    },
    "vendorId": {
      "type": [
        "string",
        "null"
      ],
      "description": "Not used; supply vendorName instead.",
      "readOnly": true
    },
    "vendorName": {
      "type": [
        "string",
        "null"
      ],
      "description": "The vendor name. Required when globalAppName does not match a global application; a local vendor is created."
    },
    "instanceName": {
      "type": [
        "string",
        "null"
      ],
      "description": "The instance name, used to distinguish multiple instances of the same application"
    },
    "status": {
      "enum": [
        "New",
        "InReview",
        "Managed",
        "Accepted",
        "Ignored",
        "PlanToClose",
        "Closed"
      ],
      "type": [
        "string",
        "null"
      ],
      "description": "The application's status. Defaults to New."
    },
    "roles": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/Role"
      },
      "description": "The application's owner roles and their members. Members are matched by ID, email or name."
    },
    "customFields": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {},
      "description": "Custom field values, keyed by the field's lookup key"
    }
  },
  "additionalProperties": false,
  "$defs": {
    "Role": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The role name"
        },
        "members": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/RoleMember"
          },
          "description": "Users who possess this role"
        }
      },
      "additionalProperties": false,
      "description": "A role"
    },
    "RoleMember": {
      "type": "object",
      "properties": {
        "userId": {
          "type": [
            "string",
            "null"
          ],
          "description": "The user's id"
        },
        "name": {
          "type": [
            "string",
            "null"
          ],
          "description": "The user's name"
        },
        "email": {
          "type": [
            "string",
            "null"
          ],
          "description": "The user's e-mail address"
        }
      },
      "additionalProperties": false,
      "description": "A member of a role"
    }
  }
}