Frontegg · Schema

EntitlementPlan

JSON Schema for Frontegg entitlements EntitlementPlan entity, derived from the published OpenAPI specification.

AuthenticationAuthorizationIdentity ManagementCIAMB2B SaaSMulti-TenancyRBACSSOSCIMEntitlementsOAuthOpenID Connect

Properties

Name Type Description
id string UUID string that represents the plan ID
vendorId string UUID string that represents the vendor ID
name string String that represents the plan name
defaultTimeLimitation number Number that represents the default time limitation in days for auto-assigned plans
description string Feature plan description
createdAt string Date when plan was created
updatedAt string Date when plan was last updated
View JSON Schema on GitHub

JSON Schema

frontegg-entitlements-entitlementplan-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/frontegg/main/json-schema/frontegg-entitlements-entitlementplan-schema.json",
  "title": "EntitlementPlan",
  "description": "JSON Schema for Frontegg entitlements EntitlementPlan entity, derived from the published OpenAPI specification.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "UUID string that represents the plan ID",
      "example": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3"
    },
    "vendorId": {
      "type": "string",
      "description": "UUID string that represents the vendor ID",
      "example": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3"
    },
    "name": {
      "type": "string",
      "description": "String that represents the plan name",
      "example": "Test Plan"
    },
    "defaultTimeLimitation": {
      "type": "number",
      "description": "Number that represents the default time limitation in days for auto-assigned plans",
      "example": "30"
    },
    "description": {
      "type": "string",
      "description": "Feature plan description",
      "example": "This is a test plan"
    },
    "createdAt": {
      "type": "string",
      "description": "Date when plan was created",
      "example": "2022-01-01T00:00:00"
    },
    "updatedAt": {
      "type": "string",
      "description": "Date when plan was last updated",
      "example": "2022-01-01T00:00:00"
    }
  },
  "required": [
    "id",
    "vendorId",
    "name",
    "createdAt"
  ]
}