ExternalGroup

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/external-group",
  "title": "ExternalGroup",
  "description": "Information about an external group's usage and its members",
  "type": "object",
  "required": [
    "group_id",
    "group_name",
    "teams",
    "members"
  ],
  "properties": {
    "group_id": {
      "description": "The internal ID of the group",
      "example": 1,
      "type": "integer"
    },
    "group_name": {
      "description": "The display name for the group",
      "example": "group-azuread-test",
      "type": "string"
    },
    "updated_at": {
      "description": "The date when the group was last updated_at",
      "example": "2021-01-03 22:27:15:000 -700",
      "type": "string"
    },
    "teams": {
      "description": "An array of teams linked to this group",
      "example": [
        {
          "team_id": 1,
          "team_name": "team-test"
        },
        {
          "team_id": 2,
          "team_name": "team-test2"
        }
      ],
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "team_id",
          "team_name"
        ],
        "properties": {
          "team_id": {
            "description": "The id for a team",
            "example": 1,
            "type": "integer"
          },
          "team_name": {
            "description": "The name of the team",
            "example": "team-test",
            "type": "string"
          }
        }
      }
    },
    "members": {
      "description": "An array of external members linked to this group",
      "example": [
        {
          "member_id": 1,
          "member_login": "mona-lisa_eocsaxrs",
          "member_name": "Mona Lisa",
          "member_email": "[email protected]"
        },
        {
          "member_id": 2,
          "member_login": "octo-lisa_eocsaxrs",
          "member_name": "Octo Lisa",
          "member_email": "[email protected]"
        }
      ],
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "member_id",
          "member_login",
          "member_name",
          "member_email"
        ],
        "properties": {
          "member_id": {
            "description": "The internal user ID of the identity",
            "example": 1,
            "type": "integer"
          },
          "member_login": {
            "description": "The handle/login for the user",
            "example": "mona-lisa_eocsaxrs",
            "type": "string"
          },
          "member_name": {
            "description": "The user display name/profile name",
            "example": "Mona Lisa",
            "type": "string"
          },
          "member_email": {
            "description": "An email attached to a user",
            "example": "[email protected]",
            "type": "string"
          }
        }
      }
    }
  }
}