Schemas #

Resource and extension schema definition #

Both resource and extension are defined in the same format. Example of a custom User resource schema:

"%custom":
  universalid:
    schemas: [
      {
        id: "urn:se:universalid:User",
        name: "customUser",
        description: "A minimal User Schema",
        attributes: [
          {
            attributeField: "value"
          }
        ]
      }
    ]

Attributes #

The attributes array contains the resource’s configured attributes. For example, you can configure a userName attribute as follows:

"%custom":
  universalid:
    schemas: [
      {
        id: "urn:se:universalid:User",
        name: "customUser",
        description: "A minimal User Schema",
        attributes: [
          {
            name: "userName",
            type: "string",
            description: "Username",
            required: true,
            caseExact: false,
            mutability: "readWrite",
            returned: "always",
            uniqueness: "server"
          }
        ]
      }
    ]