Help Contents

 

Group Users

Resource: Group Users ( /api/group/{id}/users )

Collection resource of users belonging to a group.

This resource supports the following methods: GET, PUT

Methods

GET


Retrieves all (or a subset) of users in a group.

This method supports the OData parameters $filter, $top, $take, $orderby and $inlinecount. See OData Topic for more details.

Supported Expansions

For more details on expansions, please see the Expand help topic.

Status Codes

These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

StatusDescription
200 - OKReturned if the request was completed successfully.
404 - NotFoundReturned if group does not exist.

Example - Get All Users

An example of fetching all users in group.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{id}0832C85F-E532-472F-92E1-287995CE3726ID of the group

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

[
  {
    "Id": "c699d96a-a63b-4087-bc04-c429de15dd53",
    "UserName": "joeb",
    "Email": "joeb@unknown.net",
    "FirstName": "Joe",
    "LastName": "Bloggs",
    "Phone": "(09)-555-999",
    "LastLogIn": null,
    "Enabled": true,
    "IsExternal": false,
    "Self": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53",
    "Links": [
      {
        "Href": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53/password",
        "Rel": "ChangePassword"
      },
      {
        "Href": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53/permissions/global",
        "Rel": "GlobalPermissions"
      },
      {
        "Title": "Group Memberships",
        "Href": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53/groups",
        "Rel": "Groups"
      },
      {
        "Href": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53/notifications",
        "Rel": "Notifications"
      },
      {
        "Href": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53/permissions/projects",
        "Rel": "ProjectPermissions"
      },
      {
        "Href": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53/mailmessages",
        "Rel": "MailMessages"
      }
    ]
  },
  {
    "Id": "35f32f5b-a69e-4b16-a59c-ebfb988b4bf8",
    "UserName": "janed",
    "Email": "janed@unknown.net",
    "FirstName": "Jane",
    "LastName": "Doe",
    "Phone": "(09)-555-999",
    "LastLogIn": null,
    "Enabled": true,
    "IsExternal": false,
    "Self": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8",
    "Links": [
      {
        "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/password",
        "Rel": "ChangePassword"
      },
      {
        "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/permissions/global",
        "Rel": "GlobalPermissions"
      },
      {
        "Title": "Group Memberships",
        "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/groups",
        "Rel": "Groups"
      },
      {
        "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/notifications",
        "Rel": "Notifications"
      },
      {
        "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/permissions/projects",
        "Rel": "ProjectPermissions"
      },
      {
        "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/mailmessages",
        "Rel": "MailMessages"
      }
    ]
  }
]

Status Code

200 - OK

Example - Get Users filtered by first name

An example of fetching a set of users by first name belonging to the group, by using the ODATA $filter query parameter.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{id}0832C85F-E532-472F-92E1-287995CE3726ID of the group
$filterFirstName eq 'Jane'The ODATA $filter parameter, this query parameter should be url encoded i.e. $filter=FirstName%20eq%20'Jane'.

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

[
  {
    "Id": "35f32f5b-a69e-4b16-a59c-ebfb988b4bf8",
    "UserName": "janed",
    "Email": "janed@unknown.net",
    "FirstName": "Jane",
    "LastName": "Doe",
    "Phone": "(09)-555-999",
    "LastLogIn": null,
    "Enabled": true,
    "IsExternal": false,
    "Self": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8",
    "Links": [
      {
        "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/password",
        "Rel": "ChangePassword"
      },
      {
        "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/permissions/global",
        "Rel": "GlobalPermissions"
      },
      {
        "Title": "Group Memberships",
        "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/groups",
        "Rel": "Groups"
      },
      {
        "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/notifications",
        "Rel": "Notifications"
      },
      {
        "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/permissions/projects",
        "Rel": "ProjectPermissions"
      },
      {
        "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/mailmessages",
        "Rel": "MailMessages"
      }
    ]
  }
]

Status Code

200 - OK

PUT


Sets the users that are members of the group.

This method supports the OData parameters $filter, $top, $take, $orderby and $inlinecount. See OData Topic for more details.

Required Permissions

  • Administration/Organisation/ManageUserAndGroupSecurity

Supported Expansions

For more details on expansions, please see the Expand help topic.

Status Codes

These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

StatusDescription
200 - OKReturned if the request was completed successfully.
404 - NotFoundReturned if group does not exist.

Example - Set Members

Sets the users who are members of this group.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{id}0832C85F-E532-472F-92E1-287995CE3726ID of the group

Request Body

{
  "Items": [
    {
      "Id": "c699d96a-a63b-4087-bc04-c429de15dd53"
    },
    {
      "Id": "35f32f5b-a69e-4b16-a59c-ebfb988b4bf8"
    }
  ]
}

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

[
  {
    "Id": "c699d96a-a63b-4087-bc04-c429de15dd53",
    "UserName": "joeb",
    "Email": "joeb@unknown.net",
    "FirstName": "Joe",
    "LastName": "Bloggs",
    "Phone": "(09)-555-999",
    "LastLogIn": null,
    "Enabled": true,
    "IsExternal": false,
    "Self": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53",
    "Links": [
      {
        "Href": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53/password",
        "Rel": "ChangePassword"
      },
      {
        "Href": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53/permissions/global",
        "Rel": "GlobalPermissions"
      },
      {
        "Title": "Group Memberships",
        "Href": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53/groups",
        "Rel": "Groups"
      },
      {
        "Href": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53/notifications",
        "Rel": "Notifications"
      },
      {
        "Href": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53/permissions/projects",
        "Rel": "ProjectPermissions"
      },
      {
        "Href": "http://localhost/api/user/c699d96a-a63b-4087-bc04-c429de15dd53/mailmessages",
        "Rel": "MailMessages"
      }
    ]
  },
  {
    "Id": "35f32f5b-a69e-4b16-a59c-ebfb988b4bf8",
    "UserName": "janed",
    "Email": "janed@unknown.net",
    "FirstName": "Jane",
    "LastName": "Doe",
    "Phone": "(09)-555-999",
    "LastLogIn": null,
    "Enabled": true,
    "IsExternal": false,
    "Self": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8",
    "Links": [
      {
        "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/password",
        "Rel": "ChangePassword"
      },
      {
        "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/permissions/global",
        "Rel": "GlobalPermissions"
      },
      {
        "Title": "Group Memberships",
        "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/groups",
        "Rel": "Groups"
      },
      {
        "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/notifications",
        "Rel": "Notifications"
      },
      {
        "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/permissions/projects",
        "Rel": "ProjectPermissions"
      },
      {
        "Href": "http://localhost/api/user/35f32f5b-a69e-4b16-a59c-ebfb988b4bf8/mailmessages",
        "Rel": "MailMessages"
      }
    ]
  }
]

Status Code

200 - OK