Atlassian · Schema

Group

Represents a group within an organization.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
id string The unique identifier of the group.
type string The resource type.
attributes object The attributes of the group.
View JSON Schema on GitHub

JSON Schema

atlassian-group-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Group",
  "title": "Group",
  "type": "object",
  "description": "Represents a group within an organization.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the group.",
      "example": "abc123"
    },
    "type": {
      "type": "string",
      "description": "The resource type.",
      "enum": [
        "group"
      ],
      "example": "group"
    },
    "attributes": {
      "type": "object",
      "description": "The attributes of the group.",
      "properties": {
        "name": {
          "type": "string",
          "description": "The display name of the group."
        },
        "description": {
          "type": "string",
          "description": "A description of the group."
        },
        "member_count": {
          "type": "integer",
          "description": "The number of members in the group."
        }
      },
      "example": "example_value"
    }
  }
}