Create new user group

v1.0.0

Description:

Create a new user group.

Precondition:

Right 🔓 change groups required.

Postcondition:

A new user group is created.

Further Information:

If a group should NOT expire, leave expireAt empty.
Group names are limited to 150 characters
Forbidden characters in group name: [<, >]

Input

{
  "type": "object",
  "properties": {
    "X-Sds-Auth-Token": {
      "type": "string"
    },
    "X-Sds-Date-Format": {
      "type": "string",
      "enum": [
        "UTC",
        "LOCAL",
        "OFFSET",
        "EPOCH",
        "LEET"
      ]
    },
    "expiration": {
      "type": "object",
      "description": "Expiration information",
      "required": [
        "enableExpiration"
      ],
      "properties": {
        "enableExpiration": {
          "type": "boolean",
          "description": "enabled / disabled"
        },
        "expireAt": {
          "type": "string",
          "format": "date-time",
          "description": "Expiration date"
        }
      }
    },
    "name": {
      "type": "string",
      "description": "Group name"
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Group information",
  "required": [
    "cntUsers",
    "createdAt",
    "createdBy",
    "id",
    "name"
  ],
  "properties": {
    "cntUsers": {
      "type": "integer",
      "format": "int32",
      "description": "Amount of users"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "Creation date"
    },
    "createdBy": {
      "type": "object",
      "description": "User information",
      "required": [
        "avatarUuid",
        "firstName",
        "id",
        "lastName",
        "userName",
        "userType"
      ],
      "properties": {
        "avatarUuid": {
          "type": "string",
          "description": "&#128640; Since v4.11.0\n\nAvatar UUID"
        },
        "displayName": {
          "type": "string",
          "description": "&#128679; Deprecated since v4.11.0\n\nDisplay name\n\nuse other fields from `UserInfo` instead to combine a display name"
        },
        "email": {
          "type": "string",
          "description": "&#128640; Since v4.11.0\n\nEmail "
        },
        "firstName": {
          "type": "string",
          "description": "&#128640; Since v4.11.0\n\nUser first name (mandatory if `userType` is `internal`)"
        },
        "id": {
          "type": "integer",
          "format": "int64",
          "description": "Unique identifier for the user"
        },
        "lastName": {
          "type": "string",
          "description": "&#128640; Since v4.11.0\n\nUser last name (mandatory if `userType` is `internal`)"
        },
        "title": {
          "type": "string",
          "description": "&#128679; Deprecated since v4.18.0\n\nJob title"
        },
        "userName": {
          "type": "string",
          "description": "&#128640; Since v4.13.0\n\nUsername (only returned for `internal` users)"
        },
        "userType": {
          "type": "string",
          "description": "&#128640; Since v4.11.0\n\nUser type:\n\n* `internal` - ordinary DRACOON user\n\n* `external` - external user without DRACOON account\n\n* `system` - system user (non human &#128125;)\n\n* `deleted` - deleted DRACOON user",
          "enum": [
            "system",
            "internal",
            "external",
            "deleted"
          ]
        }
      }
    },
    "expireAt": {
      "type": "string",
      "format": "date-time",
      "description": "Expiration date"
    },
    "groupRoles": {
      "type": "object",
      "description": "List of roles",
      "required": [
        "items"
      ],
      "properties": {
        "items": {
          "type": "array",
          "description": "List of roles",
          "items": {
            "type": "object",
            "description": "Role information",
            "required": [
              "description",
              "id",
              "name"
            ],
            "properties": {
              "description": {
                "type": "string",
                "description": "Role description"
              },
              "id": {
                "type": "integer",
                "format": "int32",
                "description": "Unique identifier for the role"
              },
              "items": {
                "type": "array",
                "description": "List of reachable right over role",
                "items": {
                  "type": "object",
                  "description": "Right information",
                  "required": [
                    "description",
                    "id",
                    "name"
                  ],
                  "properties": {
                    "description": {
                      "type": "string",
                      "description": "Right description"
                    },
                    "id": {
                      "type": "integer",
                      "format": "int32",
                      "description": "Unique identifier for the right"
                    },
                    "name": {
                      "type": "string",
                      "description": "Right (unique) name"
                    }
                  }
                }
              },
              "name": {
                "type": "string",
                "description": "Role (unique) name"
              }
            }
          }
        }
      }
    },
    "id": {
      "type": "integer",
      "format": "int64",
      "description": "Unique identifier for the group"
    },
    "name": {
      "type": "string",
      "description": "Group name"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "Modification date"
    },
    "updatedBy": {
      "type": "object",
      "description": "User information",
      "required": [
        "avatarUuid",
        "firstName",
        "id",
        "lastName",
        "userName",
        "userType"
      ],
      "properties": {
        "avatarUuid": {
          "type": "string",
          "description": "&#128640; Since v4.11.0\n\nAvatar UUID"
        },
        "displayName": {
          "type": "string",
          "description": "&#128679; Deprecated since v4.11.0\n\nDisplay name\n\nuse other fields from `UserInfo` instead to combine a display name"
        },
        "email": {
          "type": "string",
          "description": "&#128640; Since v4.11.0\n\nEmail "
        },
        "firstName": {
          "type": "string",
          "description": "&#128640; Since v4.11.0\n\nUser first name (mandatory if `userType` is `internal`)"
        },
        "id": {
          "type": "integer",
          "format": "int64",
          "description": "Unique identifier for the user"
        },
        "lastName": {
          "type": "string",
          "description": "&#128640; Since v4.11.0\n\nUser last name (mandatory if `userType` is `internal`)"
        },
        "title": {
          "type": "string",
          "description": "&#128679; Deprecated since v4.18.0\n\nJob title"
        },
        "userName": {
          "type": "string",
          "description": "&#128640; Since v4.13.0\n\nUsername (only returned for `internal` users)"
        },
        "userType": {
          "type": "string",
          "description": "&#128640; Since v4.11.0\n\nUser type:\n\n* `internal` - ordinary DRACOON user\n\n* `external` - external user without DRACOON account\n\n* `system` - system user (non human &#128125;)\n\n* `deleted` - deleted DRACOON user",
          "enum": [
            "system",
            "internal",
            "external",
            "deleted"
          ]
        }
      }
    }
  }
}