GET User Groups

/api/domains/:domain_id/userGroups

List user groups for domain specified by domain ID.

This resource is available only for Global admin or Domain admin.

Resource Information

Resource URL	https://service.belladati.com/api/domains/:domain_id/userGroups
HTTP Method	GET

Request Parameters

Parameter	Detail	Example
domain_id	Domain identifier	123

Response Structure

JSON response contains array "userGroups" that contains multiple user group objects with following definition:

Name	Description
id	User Group identifier
name	User Group name
description	User Group description

Sample Request / Response

Using curl:

curl -H "Authorization: OAuth realm=\"https://service.belladati.com/\", oauth_consumer_key=\"myConsumer\", oauth_token=\"mh7an9dkrg59\", oauth_timestamp=\"135131231\", oauth_nonce=\"randomString\"" https://service.belladati.com/api/domains/123/userGroups

The JSON format response:

{
  "userGroups": [
    {
      "id": "56",
      "name": "My User Group nr.1",
      "description": null
    },
    {
      "id": "345",
      "name": "My User Group nr.2",
      "description": "This is description"
    }
  ]
}

Page tree