Auth0 · Schema

Integration

Integration defines a self contained functioning unit which partners publish. A partner may create one or many of these integrations.

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM

Properties

Name	Type	Description
id	string	id is a system generated GUID. This same ID is designed to be federated in all the applicable localities.
catalog_id	string	catalog_id refers to the ID in the marketplace catalog
url_slug	string	url_slug refers to the url_slug in the marketplace catalog
partner_id	string	partner_id is the foreign key reference to the partner account this integration belongs to.
name	string	name is the integration name, which will be used for display purposes in the marketplace. To start we're going to make sure the display name is at least 3 characters. Can adjust this easily later.
description	string	description adds more text for the integration name -- also relevant for the marketplace listing.
short_description	string	short_description is the brief description of the integration, which is used for display purposes in cards
logo	string
feature_type	object
terms_of_use_url	string
privacy_policy_url	string
public_support_link	string
current_release	object
created_at	string
updated_at	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Integration",
  "title": "Integration",
  "type": "object",
  "description": "Integration defines a self contained functioning unit which partners\npublish. A partner may create one or many of these integrations.",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string",
      "description": "id is a system generated GUID. This same ID is designed to be federated in\nall the applicable localities.",
      "default": "8e9fe2d0-a2fc-4c8c-9e35-dae5afadb70b"
    },
    "catalog_id": {
      "type": "string",
      "description": "catalog_id refers to the ID in the marketplace catalog",
      "default": "awesome-auth0-integration"
    },
    "url_slug": {
      "type": "string",
      "description": "url_slug refers to the url_slug in the marketplace catalog",
      "default": "awesome-auth0-integration-slug"
    },
    "partner_id": {
      "type": "string",
      "description": "partner_id is the foreign key reference to the partner account this\nintegration belongs to.",
      "default": "b8575c12-8d9d-4b5c-b28e-671fe9d39029"
    },
    "name": {
      "type": "string",
      "description": "name is the integration name, which will be used for display purposes in\nthe marketplace.\n\nTo start we're going to make sure the display name is at least 3\ncharacters. Can adjust this easily later.",
      "default": "Example Auth0 integration"
    },
    "description": {
      "type": "string",
      "description": "description adds more text for the integration name -- also relevant for\nthe marketplace listing.",
      "default": "An awesome Auth0 integration"
    },
    "short_description": {
      "type": "string",
      "description": "short_description is the brief description of the integration, which is used for display purposes in cards",
      "default": "Awesome Auth0 integration"
    },
    "logo": {
      "type": "string"
    },
    "feature_type": {
      "$ref": "#/components/schemas/IntegrationFeatureTypeEnum"
    },
    "terms_of_use_url": {
      "type": "string"
    },
    "privacy_policy_url": {
      "type": "string"
    },
    "public_support_link": {
      "type": "string"
    },
    "current_release": {
      "$ref": "#/components/schemas/IntegrationRelease"
    },
    "created_at": {
      "type": "string",
      "default": "2021-06-21T15:47:29.072Z",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "default": "2021-06-21T15:47:29.072Z",
      "format": "date-time"
    }
  }
}