University of Cambridge · Schema

Group

A group record returned by the Cambridge Lookup/Ibis web service API.

EducationHigher EducationUniversityResearchUnited KingdomIdentityAPI GatewayDeveloper Portal

Properties

Name Type Description
cancelled boolean Flag indicating if the group is cancelled.
groupid string The group's numeric ID (a string, e.g., "100656").
name string The group's unique name (e.g., "cs-editors").
title string The group's title.
description string The more detailed description of the group.
email string The group's email address.
members array A list of the group's members, including recursively included groups (only populated when fetch includes all_members).
View JSON Schema on GitHub

JSON Schema

university-of-cambridge-group-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://www.lookup.cam.ac.uk/schema/group.json",
  "title": "Group",
  "description": "A group record returned by the Cambridge Lookup/Ibis web service API.",
  "type": "object",
  "properties": {
    "cancelled": {
      "type": "boolean",
      "description": "Flag indicating if the group is cancelled."
    },
    "groupid": {
      "type": "string",
      "description": "The group's numeric ID (a string, e.g., \"100656\")."
    },
    "name": {
      "type": "string",
      "description": "The group's unique name (e.g., \"cs-editors\")."
    },
    "title": {
      "type": "string",
      "description": "The group's title."
    },
    "description": {
      "type": "string",
      "description": "The more detailed description of the group."
    },
    "email": {
      "type": "string",
      "description": "The group's email address."
    },
    "members": {
      "type": "array",
      "items": { "$ref": "https://www.lookup.cam.ac.uk/schema/person.json" },
      "description": "A list of the group's members, including recursively included groups (only populated when fetch includes all_members)."
    }
  }
}