Microsoft Azure Active Directory · Schema

GroupCreate

Properties required when creating a new group.

AuthenticationAuthorizationIdentityMicrosoftMicrosoft EntraOAuthOpenID ConnectSAMLSCIMSingle Sign-OnZero Trust

Properties

Name	Type	Description
displayName	string	The display name for the group.
description	string
groupTypes	array	Set to ["Unified"] for Microsoft 365 groups. Omit for security groups.
mailEnabled	boolean
mailNickname	string
securityEnabled	boolean
visibility	string
isAssignableToRole	boolean
[email protected]	array	List of directory object URLs to add as members. Example: https://graph.microsoft.com/v1.0/directoryObjects/{id}
[email protected]	array	List of directory object URLs to set as owners.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GroupCreate",
  "title": "GroupCreate",
  "type": "object",
  "description": "Properties required when creating a new group.",
  "required": [
    "displayName",
    "mailEnabled",
    "mailNickname",
    "securityEnabled"
  ],
  "properties": {
    "displayName": {
      "type": "string",
      "description": "The display name for the group.",
      "example": "example_value"
    },
    "description": {
      "type": "string",
      "example": "A sample description."
    },
    "groupTypes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Set to [\"Unified\"] for Microsoft 365 groups. Omit for security groups.",
      "example": []
    },
    "mailEnabled": {
      "type": "boolean",
      "example": true
    },
    "mailNickname": {
      "type": "string",
      "example": "example_value"
    },
    "securityEnabled": {
      "type": "boolean",
      "example": true
    },
    "visibility": {
      "type": "string",
      "enum": [
        "Public",
        "Private",
        "HiddenMembership"
      ],
      "example": "Public"
    },
    "isAssignableToRole": {
      "type": "boolean",
      "example": true
    },
    "[email protected]": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      },
      "description": "List of directory object URLs to add as members. Example: https://graph.microsoft.com/v1.0/directoryObjects/{id}",
      "example": []
    },
    "[email protected]": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      },
      "description": "List of directory object URLs to set as owners.",
      "example": []
    }
  }
}