Adobe Captivate · JSON Structure

Prime Api User Group Structure

A group of users for organizing and targeting content

Type: object Properties: 3
AuthoringEducationeLearningLMSSCORMTrainingxAPI

UserGroup is a JSON Structure definition published by Adobe Captivate, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id type attributes

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adobe-captivate/refs/heads/main/json-structure/prime-api-user-group-structure.json",
  "name": "UserGroup",
  "description": "A group of users for organizing and targeting content",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique user group identifier"
    },
    "type": {
      "type": "string",
      "const": "userGroup"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "dateCreated": {
          "type": "datetime",
          "description": "Timestamp when the group was created"
        },
        "description": {
          "type": "string",
          "description": "Group description"
        },
        "name": {
          "type": "string",
          "description": "Group name"
        },
        "state": {
          "type": "string",
          "description": "Group state",
          "enum": [
            "Active",
            "Deleted"
          ]
        },
        "userCount": {
          "type": "int32",
          "description": "Number of users in the group"
        }
      }
    }
  }
}