/api/space/group-management/groups/{id}/users

The following operations are supported on this resource:

  • GET - Get all users belonging to the group
  • POST - Associate a user with a group
GET /groups/{id}/usersVersion 1

Get all users belonging to the group.

Sample Usage

GET /groups/{id}/users


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    group-idIntegerPathgroup ID Y
  • Sample Output XML:
    <users total="1" uri="/api/space/group-management/groups/32768/users">
        <user href="/api/space/user-management/users/2">
            <auth-mode>Local</auth-mode>
            <first-name>testFirst</first-name>
            <groups uri="/api/space/group-management/groups/32768/users/groups">
                <group href="/api/space/group-management/groups/32768" uri="/api/space/group-management/groups/32768/users/groups/32768">
                        <id>32768</id>
                        <name>GroupCreated_SuperUser</name>
                </group>
                <group href="/api/space/group-management/groups/32770" uri="/api/space/group-management/groups/32768/users/groups/32770">
                    <id>32770</id>
                    <name>Group_WithNormalUser_assign</name>
                </group>
                <group href="/api/space/group-management/groups/32772" uri="/api/space/group-management/groups/32768/users/groups/32772">
                    <id>32772</id>
                    <name>Group_created_test</name>
                </group>
            </groups>
            <id>2</id>
            <last-name>testLast</last-name>
            <name>test</name>
            <primary-email>test@juniper.net</primary-email>
            <status>Enabled</status>
        </user>
    </users>

  • Sample Output JSON:
    {  
        "users":{  
            "@uri":"/api/space/group-management/groups/32768/users",
            "@total":"1",
            "user":[  
                {  
                    "@href":"/api/space/user-management/users/2",
                    "primary-email":"test@juniper.net",
                    "auth-mode":"Local",
                    "status":"Enabled",
                    "groups":{  
                        "@uri":"/api/space/group-management/groups/32768/users/groups",
                        "group":[  
                            {  
                                "@href":"/api/space/group-management/groups/32768",
                                "@uri":"/api/space/group-management/groups/32768/users/groups/32768",
                                "id":32768,
                                "name":"GroupCreated_SuperUser"
                            },
                            {  
                                "@href":"/api/space/group-management/groups/32770",
                                "@uri":"/api/space/group-management/groups/32768/users/groups/32770",
                                "id":32770,
                                "name":"Group_WithNormalUser_assign"
                            },
                            {  
                                "@href":"/api/space/group-management/groups/32772",
                                "@uri":"/api/space/group-management/groups/32768/users/groups/32772",
                                "id":32772,
                                "name":"Group_created_test"
                            }
                        ]
                    },
                    "last-name":"testLast",
                    "id":2,
                    "name":"test",
                    "first-name":"testFirst"
                }
            ]
        }
    }

  • Access Control

    The following capabilities are required to access this API: DefaultRead

    POST /groups/{id}/usersVersion 1

    Associate a user with a group.

    Sample Usage

    POST /groups/{id}/users


    • Parameters:
      NameTypeURI TypeDescriptionRequired
      group-idIntegerPathgroupId ID Y
  • Sample Input XML:
    <user href="/api/space/user-management/users/3" />

  • Sample Input JSON:
    {  
        "user":{  
            "@href":"/api/space/user-management/users/3"
        }
    }

  • Access Control

    The following capabilities are required to access this API: AssignGroup2User