Skip to main content

    Web Service Method: Request User Groups

    Abstract

    Web Service Method: Request User Groups

    Description

    Returns a list of group names of the PoolParty server.

    Note

    With groups you can control access to projects per user. See also: User Groups in PoolParty

    URL: /PoolParty/api/user/groups

    Request

    Supported Methods

    GET

    Content-Type

    application/x-www-form-urlencoded

    Response

    http status code 200if OK.

    JSON formatted response:

    Attribute

    Type

    Comment

    name

    String

    Group name

    Example

    URL Pattern
    https://<server-url>/PoolParty/api/user/groups

    JSON Formatted Response Example 

    [
        {
                name: "test group"
        },
        {
        "name": "Public"
    },
    {
        "name": "SWC"
    }
]
    In this section: