User Group APIs

Get User Group

OVERVIEW

Overview

Get a user group from Publisher

This API call is used to retrieve a user group from the system. The group identifier is the group id.

Since v4.6

HTTP Request

GET  /api/2/groups/<ID>

 

URL Parameters
Parameter Description
ID The ID of the group to retrieve

 

HTTP Headers
HTTP Request Header Description Example
Authorization The API Authorisation token. "Bearer XXXXXXXXXXXXX"
Accept

The format of the expected response. 

  • "application/json"
  • "application/xml"

If no parameter is set, JSON is the default response given.

 "application/xml"
Content-Type

The format of the provided content.

  • "application/json"
  • "application/xml"

If no parameter is set, JSON is the expected content by default.

 "application/json"

 

HTTP Response

Success

HTTP response 200 with User Group object

(Example below)

 

Error

See  API Error messages 

 

Example HTTP Request & Response

GET http://example.com/context/api/2/groups/3

 

JSON Response

{

    "group": {

        "id": 3,

        "name": "Internal Users",

        "users": [

            456,

            22,

            98107,

            ....

        ]

    }

}

 

 

XML Response

<group>

    <id>3</id>

    <name>Internal Users</name>

    <users>

        <user>456</user>

        <user>22</user>

        <user>98107</user>

        ....

    </users>

</group>

 

Comments


0 Comments

Last Updated: Nov 08,2024