Atlassian · Schema

FoundGroup

A group found in a search.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
groupId string The ID of the group, which uniquely identifies the group across all Atlassian products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*.
html string The group name with the matched query string highlighted with the HTML bold tag.
labels array
name string The name of the group. The name of a group is mutable, to reliably identify a group use ``groupId`.`
View JSON Schema on GitHub

JSON Schema

atlassian-foundgroup-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FoundGroup",
  "title": "FoundGroup",
  "additionalProperties": false,
  "description": "A group found in a search.",
  "properties": {
    "groupId": {
      "description": "The ID of the group, which uniquely identifies the group across all Atlassian products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*.",
      "type": "string"
    },
    "html": {
      "description": "The group name with the matched query string highlighted with the HTML bold tag.",
      "type": "string"
    },
    "labels": {
      "items": {
        "$ref": "#/components/schemas/GroupLabel"
      },
      "type": "array"
    },
    "name": {
      "description": "The name of the group. The name of a group is mutable, to reliably identify a group use ``groupId`.`",
      "type": "string"
    }
  },
  "type": "object",
  "xml": {
    "name": "group"
  }
}