Select the tab
ESET Connect – Table of Contents

POST Create group

Relative path: /v1/groups

Create a [Group] in the hierarchy and assign a UUID to it.

Base URL for Europe, Germany, United States, Canada and Japan regions:






Request body

Display Schema instead of an Example or vice-versa

Type

Required

Example

Schema

application/json

Yes

 
{
  "group": {
    "description": "string",
    "displayName": "string",
    "linkedEntityType": "GROUP_ENTITY_TYPE_UNSPECIFIED",
    "parentGroupUuid": "string",
    "uuid": "string",
    "ownerUuid": "string"
  }
}
 
{
  "$ref": "v1CreateGroupRequest",
  "group": {
    "$ref": "v1Group",
    "description": {
      "type": "string",
      "description": "Group description. Free text."
    },
    "displayName": {
      "type": "string",
      "description": "User-friendly name of the group."
    },
    "linkedEntityType": {
      "$ref": "v1GroupEntityType",
      "type": "string",
      "description": "Possible entities that the Group represents. GROUP_ENTITY_TYPE_UNSPECIFIED: fallback GROUP_ENTITY_TYPE_CUSTOMER: Group representing [company] GROUP_ENTITY_TYPE_MSP: Group representing [MSP] GROUP_ENTITY_TYPE_SITE: Group representing [site] GROUP_ENTITY_TYPE_HOUSEHOLD: Group representing [household]",
      "default": "GROUP_ENTITY_TYPE_UNSPECIFIED",
      "enum": [
        "GROUP_ENTITY_TYPE_UNSPECIFIED",
        "GROUP_ENTITY_TYPE_CUSTOMER",
        "GROUP_ENTITY_TYPE_MSP",
        "GROUP_ENTITY_TYPE_SITE",
        "GROUP_ENTITY_TYPE_HOUSEHOLD"
      ]
    },
    "parentGroupUuid": {
      "type": "string",
      "description": "Reference to the parent group in the tree structure. type: Group"
    },
    "uuid": {
      "type": "string",
      "description": "Unique identifier of the entity. Must be collision-free - two identifiers created anywhere in the world must not collide within entity parent scope. Unless a member of aggregate, the entity scope is always global. Although most of the times compliant with RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace, do not rely on it being a RFC UUID. Treat it as an opaque identifier. RFC UUID can be recognized by being formatted according to the template xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx, as explained on Wikipedia. UUID is used for referencing an entity, even across domains. Example: '123e4567-e89b-12d3-a456-426614174000'"
    },
    "ownerUuid": {
      "type": "string",
      "description": "Identifier of the tenant who owns this object.",
      "readOnly": true
    }
  }
}

Responses

Display Schema+Headers instead of an Example or vice-versa

Code

Description and Example

Description, Schema and Headers

200

Successful response.


Response example

{
  "group": {
    "description": "string",
    "displayName": "string",
    "linkedEntityType": "GROUP_ENTITY_TYPE_UNSPECIFIED",
    "parentGroupUuid": "string",
    "uuid": "string",
    "ownerUuid": "string"
  }
}

Successful response.


Response schema

{
  "$ref": "v1CreateGroupResponse",
  "group": {
    "$ref": "v1Group",
    "description": {
      "type": "string",
      "description": "Group description. Free text."
    },
    "displayName": {
      "type": "string",
      "description": "User-friendly name of the group."
    },
    "linkedEntityType": {
      "$ref": "v1GroupEntityType",
      "type": "string",
      "description": "Possible entities that the Group represents. GROUP_ENTITY_TYPE_UNSPECIFIED: fallback GROUP_ENTITY_TYPE_CUSTOMER: Group representing [company] GROUP_ENTITY_TYPE_MSP: Group representing [MSP] GROUP_ENTITY_TYPE_SITE: Group representing [site] GROUP_ENTITY_TYPE_HOUSEHOLD: Group representing [household]",
      "default": "GROUP_ENTITY_TYPE_UNSPECIFIED",
      "enum": [
        "GROUP_ENTITY_TYPE_UNSPECIFIED",
        "GROUP_ENTITY_TYPE_CUSTOMER",
        "GROUP_ENTITY_TYPE_MSP",
        "GROUP_ENTITY_TYPE_SITE",
        "GROUP_ENTITY_TYPE_HOUSEHOLD"
      ]
    },
    "parentGroupUuid": {
      "type": "string",
      "description": "Reference to the parent group in the tree structure. type: Group"
    },
    "uuid": {
      "type": "string",
      "description": "Unique identifier of the entity. Must be collision-free - two identifiers created anywhere in the world must not collide within entity parent scope. Unless a member of aggregate, the entity scope is always global. Although most of the times compliant with RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace, do not rely on it being a RFC UUID. Treat it as an opaque identifier. RFC UUID can be recognized by being formatted according to the template xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx, as explained on Wikipedia. UUID is used for referencing an entity, even across domains. Example: '123e4567-e89b-12d3-a456-426614174000'"
    },
    "ownerUuid": {
      "type": "string",
      "description": "Identifier of the tenant who owns this object.",
      "readOnly": true
    }
  }
}


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

202

Response took too long; request cached. Response can be retrieved later using the response-id header.

Response took too long; request cached. Response can be retrieved later using the response-id header.


Response schema

[]


Headers

{
  "response-id": {
    "description": "Unique ID of a pending request. Used to retrieve cached result.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  },
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

400

One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided.

One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

401

Token has expired or is invalid.

Token has expired or is invalid.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

403

Access denied. Check permissions.

Access denied. Check permissions.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

404

Requested resource not found.

Requested resource not found.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

429

Rate limit reached. Try again later.

Rate limit reached. Try again later.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

500

Internal server failure. Try again later.

Internal server failure. Try again later.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

502

Internal server failure. Try again later.

Internal server failure. Try again later.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

503

Environment under maintenance. Try again later.

Environment under maintenance. Try again later.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

504

Action took too long; timeout reached

Action took too long; timeout reached


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}