---
updatedAt: 2026-07-20T23:26:36.000Z
agentTools:
  projectIndex: https://synaccess.readme.io/llms.txt
---

# Add A User To A Group

Grant a user direct access to a group.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Cloud.Synaccess",
    "version": "1.3"
  },
  "servers": [
    {
      "url": "https://cloud.synaccess.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "name": "authorization",
        "in": "header",
        "x-default": "Bearer"
      }
    },
    "schemas": {
      "GroupUser": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Unique database identifier for the user."
          },
          "user_id": {
            "type": "string",
            "description": "Public user identifier, when available."
          },
          "email_id": {
            "type": "string",
            "description": "Username or email address for the user."
          },
          "is_enterprise_admin": {
            "type": "boolean"
          },
          "has_admin_privileges": {
            "type": "boolean"
          },
          "active_in_enterprise": {
            "type": "boolean"
          }
        }
      },
      "GroupUserMembershipRequest": {
        "type": "object",
        "required": [
          "user_id"
        ],
        "properties": {
          "user_id": {
            "type": "string",
            "description": "ID of the user to add to or remove from the group."
          }
        }
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "tags": [
    {
      "name": "Groups",
      "description": "Group inventory and management endpoints."
    }
  ],
  "x-tagGroups": [
    {
      "name": "Devices",
      "tags": [
        "Device Inventory",
        "Device Live Telemetry",
        "Device Logs",
        "Configuration",
        "Firmware"
      ]
    },
    {
      "name": "Power Control",
      "tags": [
        "Outlets",
        "PDU Outlet Groups",
        "Inlets",
        "Banks",
        "Sensors"
      ]
    },
    {
      "name": "Automation",
      "tags": [
        "Events",
        "Actions"
      ]
    },
    {
      "name": "Organization",
      "tags": [
        "Groups"
      ]
    }
  ],
  "paths": {
    "/v1/groups/{group_id}/addUser": {
      "post": {
        "summary": "Add A User To A Group",
        "description": "Grant a user direct access to a group.",
        "operationId": "add-user-to-group",
        "parameters": [
          {
            "name": "group_id",
            "in": "path",
            "description": "Unique ID for a previously created group",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/GroupUserMembershipRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "User added to the group",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/GroupUser"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Group or user was not found, or the user already has group access"
          },
          "403": {
            "description": "The authenticated user cannot modify this group"
          }
        },
        "deprecated": false,
        "tags": [
          "Groups"
        ]
      }
    }
  }
}
```