user-groups

Updates an existing user group.

This resource is an alias of /gdc/userGroups/{groupId}.

put/gdc/internal/usergroups/{groupId}

Request

Base URL
https://secure.gooddata.com
Auth
none declared

Path parameters

groupIdstring required

Id of the group which you want to update.

Request body

Example request

{
  "userGroup": {
    "content": {
      "name": "Group1",
      "domain": "/gdc/domains/default",
      "project": "/gdc/projects/{project_id}"
    },
    "meta": {
      "created": "2020-01-08 15:44:23",
      "updated": "2020-01-08 15:44:23"
    },
    "links": {
      "self": "/gdc/userGroups/{group_id}",
      "members": "/gdc/userGroups/{group_id}/members",
      "modifyMembers": "/gdc/userGroups/{group_id}/modifyMembers"
    }
  }
}

Response

The user group was successfully updated.

Example response

{
  "userGroup": {
    "content": {
      "name": "Group1",
      "domain": "/gdc/domains/default",
      "project": "/gdc/projects/{project_id}"
    },
    "meta": {
      "created": "2020-01-08 15:44:23",
      "updated": "2020-01-08 15:44:23"
    },
    "links": {
      "self": "/gdc/userGroups/{group_id}",
      "members": "/gdc/userGroups/{group_id}/members",
      "modifyMembers": "/gdc/userGroups/{group_id}/modifyMembers"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.