Skip to main content

Web Service Method: Add Group to Project

Abstract

Web Service Method: Add Group to Project

Description

This service allows to add existing groups to project metadata. Groups are used to grant access to projects for different user groups.

You can also grant groups access to projects during project creation: New Project - User Groups or for existing projects in the Project Details.

Note

Find more details on groups in PoolParty: User Groups in PoolParty.

You can use the Web Service Method: Request User Groups to get a list of existing user groups.

URL: /PoolParty/api/projects/{project}/addGroup

Request

Supported Methods

POST

Content-Type

application/x-www-form-urlencoded

Path Variables

Variable

Comment

{project}

The UUID or the URI supplement (textual identifier) of the project to be used.

HTTP Parameters

Parameter

Comment

Type

Required

names

Names of the groups that should be added to the project. Use comma separated string when multiple group names should be added.

String

true

Response

Returns status 200 when method was executed successfully.

Example

Usage of REST Client

The following screenshot shows the usage of the import service using Postman:

Use POST to add two new groups: