---
title: "Add users to a group"
method: POST
path: "/v2/groups/{group_id}:addUsers"
tags: ["Groups"]
---

# Add users to a group

`POST /v2/groups/{group_id}:addUsers`

## Request

- Base URL: `https://api.byndid.com`
- URL: `https://api.byndid.com/v2/groups/{group_id}:addUsers`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-workforce-api/docs/v2/groups/:group_id:addUsers/post.ts> (a function with typed inputs; its response is checked against the schema)

To add users to a group, send a POST request to
`/v2/groups/$GROUP_ID:addUsers`. The request may include up to 1000 users
to add. Users which already belong to the group will be ignored.

Note that this endpoint does not support adding users to permission groups.
If the request attempts to add users to a permission group, you'll receive
a 403 error.

## Path parameters

- `group_id` string, required

## Request body

- object: Request for AddGroupUsers.
  - `id` string: ID of the group.
  - `user_ids` string[]: IDs of the users to be added to the group.

## Response `200`

The response is a JSON object containing standard group attributes.

- Group: A group is a collection of members within an organization that uses Beyond Identity.
  - `id` string: A unique identifier for the group within a tenant that is automatically generated on creation. This field is immutable and read-only.
  - `create_time` string, date-time: A time value in the ISO8601 combined date and time format that gets generated automatically and represents the time the group gets created. This field is immutable and read-only.
  - `update_time` string, date-time: A time value in the ISO8601 combined date and time format that gets generated automatically and represents the time the group gets updated. This field is read-only.
  - `tenant_id` string: A unique identifier for the group's tenant that is set automatically on creation. This field is immutable and read-only.
  - `name` string: A required unique name for the group within the tenant.
  - `description` string: A required description for the group within the tenant.
  - `source` string: The source that created the group. This field is immutable and read-only.

## Other responses

- `401`: Unauthorized.
- `403`: Forbidden.
- `404`: The resource was not found.
- `429`: Rate limit exceeded.
- `500`: Server error.

---

[API](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-workforce-api.md) - [All operations](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-workforce-api/llms.txt) - [OpenAPI document](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-workforce-api/revisions/562e14b2e4ba?raw)