Sign in

v1

latestOpenAPI 3.0.12026-08-041753011.2 MB
Group

Add users to a group

post/v1/workspaces/{workspaceId}/user-groups/{userGroupId}/users

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Represents a workspace identifier across the system.

userGroupIdstring required

Represents a user group identifier across the system.

Example:76a687e29ae1f428e7ebe101

Represents a user group identifier across the system.

Request body

userIdstring required

Represents a user identifier across the system.

Example request

{
  "userId": "5a0ab5acb07987125438b60f"
}

Response

OK

idstring

Represents a user group identifier across the system.

namestring

Represents a user group name.

userIdsstring[]

Represents a list of users' identifiers across the system.

workspaceIdstring

Represents a workspace identifier across the system.

Example response

{
  "id": "76a687e29ae1f428e7ebe101",
  "name": "development_team",
  "teamManagers": [
    {
      "id": "672323eb0024343a1585e8a7",
      "name": "Jane Doe"
    }
  ],
  "userIds": [
    "5a0ab5acb07987125438b60f",
    "98j4b5acb07987125437y32"
  ],
  "workspaceId": "64a687e29ae1f428e7ebe303"
}