System Group APIs

Add user to a system group

OVERVIEW

Overview

This API call is used to add users in a system group.

HTTP Request

POST  /api/3/groups/<GROUPID>/users

URL Parameters
Parameter Description
GROUPID The ID of the system group

 

HTTP Request Object

POST http://example.com/context/api/3/groups/3/users

 

XML Request Example

<user>
    <userid>100</userid>
    <userid>101</userid>
</user>

 

JSON Request Example

{
    "userid":[
        100,
        101]
}
HTTP Response
Success

HTTP response 201

 

Error messages

 

Summary Ref Code (before V4) Ref Code (V4)
The following users do not exist within the system: 110 110
The group does not exist within the system    126 126
The Group id is not in the proper format   124 124
A User id is required 109 109
Archived user(s) cannot be added to the system group: N/A 394
A user cannot be added to an auto-created group    N/A 299

Comments


0 Comments

Last Updated: Nov 08,2024