Group - Adds users to a group

Performs a bulk operation to add multiple users to a designated group.

POST/tenants/{tenantId}/groups/{groupId}/users

Authorization

Bearer

Path parameters

tenantId*string (uuid)

Enter the ID of the tenant under which users will be added to the group.

groupId*string (uuid)

Enter the ID of the group to which users will be added.

Query parameters

Body

application/jsontext/jsonapplication/*+json

itemsstring (uuid)

Response

200500

Success: Addition acknowledgment received.

Body

text/plainapplication/jsontext/json

statusenum

Enum for tenant name availablity.

SuccessPartialSuccessFailure

successCountinteger (int32)

A public property of type int that has both a getter and a setter method, which allows for getting and setting the value of the SuccessCount property.

errorobject

Class for representing response model for user assignment errors.

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/tenants/{tenantId}/groups/{groupId}/users', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      "123e4567-e89b-12d3-a456-426614174000"
    ]),
});
const data = await response.json();

Response

200500

{
  "status": "Success",
  "successCount": 0,
  "error": {
    "message": "text",
    "unsuccessfulUsers": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }
}