GOgooddata
user-groups

Returns a paged list of user groups.

You can specify both filtering and paging. Use only the following filter combinations:

  • project - List all groups for this project.

  • project + user - List groups that this user is belongs to for this project. The user must be part of the project.

  • project + userGroup - List groups that this user group belongs to for this project. The user group must be part of the project.

get/gdc/userGroups

Request

  • Base URL
    https://secure.gooddata.com
  • Auth
    none declared. Required headers: Accept

Query parameters

userstring

Optional user UID filter.

projectstring

Project filter. Mandatory in most cases.

userGroupstring

Optional user group filter.

includeImplicitboolean

Include implicit user groups.

includeIndirectboolean

Include indirect user groups.

includeParentboolean

Include parent user groups.

uriOnlyboolean

Do return list of URIs instead of full objects.

offsetstring

Offset

limitinteger

Limit

Headers

Acceptstring required

Response

List of user groups fulfilling criteria successfully returned

OR

Example response

{
  "userGroups": {
    "paging": {
      "next": "/gdc/userGroups?offset=aORlf51hDa_22Z3C1XuseVw"
    },
    "items": [
      {
        "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.