Skip to content

Schema example

This is an example schema including one custom resource, persons and groups.
Your own schema must define one or more custom resources, and may include persons and groups if needed.
This example includes all the attributes that can be included. The only mandatory attribute is id, you can remove the attributes you don't need.

[
  {
    "name": "YourResourceNameHere",
    "properties": [
      {
        "name": "id",
        "property_type": "String",
        "id": true
      },
      {
        "name": "name",
        "property_type": "String",
      },
      {
        "name": "state",
        "property_type": "String",
      },
      {
        "name": "ownerId",
        "property_type": "Reference",
      },
      {
        "name": "owner",
        "property_type": "String",
      },
      {
        "name": "administratorsId",
        "property_type": "Reference",
      },
      {
        "name": "administrators",
        "property_type": "String",
      }
    ]
  },
  {
    "name": "Person",
    "properties": [
      {
        "name": "id",
        "property_type": "String",
        "id": true
      },
      {
        "name": "name",
        "property_type": "String",
      },
      {
        "name": "accountType",
        "property_type": "String",
      },
      {
        "name": "email",
        "property_type": "String",
      },
      {
        "name": "firstName",
        "property_type": "String",
      },
      {
        "name": "lastName",
        "property_type": "String",
      },
      {
        "name": "department",
        "property_type": "String",
      },
      {
        "name": "group",
        "property_type": "String",
      },
      {
        "name": "section",
        "property_type": "String",
      },
      {
        "name": "ownerId",
        "property_type": "Reference",
      },
      {
        "name": "owner",
        "property_type": "String",
      }
    ]
  },
  {
    "name": "Group",
    "properties": [
      {
        "name": "id",
        "property_type": "String",
        "id": true
      },
      {
        "name": "name",
        "property_type": "String",
      },
      {
        "name": "email",
        "property_type": "String",
      },
      {
        "name": "ownerId",
        "property_type": "Reference",
      },
      {
        "name": "owner",
        "property_type": "String",
      }
    ]
  }
]

```