App

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/1password/json-schema/1password-app-schema.json",
  "title": "App",
  "description": "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/App",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The application's unique ID"
    },
    "name": {
      "type": "string",
      "description": "The application name"
    },
    "description": {
      "type": "string",
      "description": "A description of the application"
    },
    "instanceName": {
      "type": "string",
      "description": "The instance name, used to distinguish multiple instances of the same application"
    },
    "status": {
      "enum": [
        "New",
        "InReview",
        "Managed",
        "Accepted",
        "Ignored",
        "PlanToClose",
        "Closed"
      ],
      "type": "string",
      "description": "The application's status in SaaS Manager."
    },
    "riskLevel": {
      "type": "string",
      "description": "Optional OAuth access risk level: Low, Medium or High"
    },
    "vendor": {
      "allOf": [
        {
          "$ref": "#/$defs/CompactVendor"
        }
      ],
      "description": "The application's vendor"
    },
    "licenses": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/License"
      },
      "description": "The application's license plans"
    },
    "customFields": {
      "type": "object",
      "additionalProperties": {},
      "description": "Custom field values, keyed by the field's lookup key. Each value is the field's value directly: a string (text/single-select), a number, an ISO-8601 date, or an array of strings (multi-select)."
    },
    "createdBy": {
      "allOf": [
        {
          "$ref": "#/$defs/UserInfo"
        }
      ],
      "description": "The user that created the application record"
    },
    "createdDtm": {
      "type": "string",
      "description": "The timestamp for when the application record was created",
      "format": "date-time"
    },
    "deleted": {
      "type": "boolean",
      "description": "Whether the application has been deleted"
    },
    "lastModifiedDtm": {
      "type": "string",
      "description": "The timestamp for when the application record was last modified",
      "format": "date-time"
    },
    "roles": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Role"
      },
      "description": "The application's owner roles and their members"
    },
    "isGlobal": {
      "type": "boolean",
      "description": "Whether the application is recognised in the global application catalog"
    },
    "mainCategory": {
      "allOf": [
        {
          "$ref": "#/$defs/Tag"
        }
      ],
      "description": "The application's primary category"
    },
    "otherCategories": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Tag"
      },
      "description": "The application's additional categories"
    },
    "domains": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The application's domains"
    },
    "logoUrl": {
      "type": "string",
      "description": "A URL for the application's logo"
    },
    "signOnUrl": {
      "type": "string",
      "description": "The application's single sign-on URL"
    },
    "links": {
      "allOf": [
        {
          "$ref": "#/$defs/AppLinks"
        }
      ],
      "description": "Links to pages containing application details"
    }
  },
  "additionalProperties": false,
  "$defs": {
    "AppLinks": {
      "type": "object",
      "properties": {
        "application": {
          "type": "string",
          "description": "The application url, typically the sign on page"
        },
        "blog": {
          "type": "string",
          "description": "Official application blog url"
        },
        "help": {
          "type": "string",
          "description": "The url of the application's documentation or help"
        },
        "homePage": {
          "type": "string",
          "description": "The home page for the application"
        },
        "pricing": {
          "type": "string",
          "description": "A page with application pricing details"
        },
        "privacyPolicy": {
          "type": "string",
          "description": "A page containing application's privacy policy"
        },
        "security": {
          "type": "string",
          "description": "A page containing security information for the application"
        },
        "signUp": {
          "type": "string",
          "description": "The application's sign up page"
        },
        "termsOfService": {
          "type": "string",
          "description": "The application's terms and conditions page. Never read, much like this text"
        }
      },
      "additionalProperties": false,
      "description": "Links to pages containing application details"
    },
    "CompactVendor": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The vendor's id"
        },
        "name": {
          "type": "string",
          "description": "The vendor's name"
        }
      },
      "additionalProperties": false,
      "description": "An app vendor"
    },
    "License": {
      "type": "object",
      "properties": {
        "name": {
          "type": [
            "string",
            "null"
          ],
          "description": "The name of the license",
          "readOnly": true
        },
        "licensePlanId": {
          "type": [
            "string",
            "null"
          ],
          "description": "The licence plan id",
          "readOnly": true
        },
        "startDate": {
          "type": "string",
          "description": "The date the license started",
          "format": "date-time",
          "readOnly": true
        },
        "renewalDate": {
          "type": [
            "string",
            "null"
          ],
          "description": "The renewal date of the license",
          "format": "date-time",
          "readOnly": true
        },
        "terminatedDate": {
          "type": [
            "string",
            "null"
          ],
          "description": "The date the license was terminated",
          "format": "date-time",
          "readOnly": true
        },
        "lastModifiedDtm": {
          "type": [
            "string",
            "null"
          ],
          "description": "The timestamp that this data was last updated at",
          "format": "date-time",
          "readOnly": true
        }
      },
      "additionalProperties": false,
      "description": "App license details"
    },
    "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"
    },
    "Tag": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The tag id"
        },
        "name": {
          "type": "string",
          "description": "The tag"
        },
        "nameIntl": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "International version of the tag"
        }
      },
      "additionalProperties": false,
      "description": "A tag"
    },
    "UserInfo": {
      "type": "object",
      "properties": {
        "userId": {
          "type": [
            "string",
            "null"
          ]
        },
        "name": {
          "type": [
            "string",
            "null"
          ]
        },
        "email": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "additionalProperties": false
    }
  }
}