GET /api/users/{UserID}/groups

Returns information about the groups that the specified user is a member of.

Authorization Roles/Permissions: Must be logged in. Self (logged in) or Site Admin (for any user).

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/users/{UserID}/groups

Sample Request

The example below shows a request for the groups the specified user is a member of.

Sample Request URL 

https://{hostname}/api/users/957482b9-ck7f-0gk5-ae07-9flgok5djtus.acmepaymentscorp/groups

Sample request headers 

Accept: application/json

Sample request body

Not applicable.

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept

application/json, text/xml

application/rss+xml

application/vnd.soa.v71+json, application/vnd.soa.v71+xml

application/vnd.soa.v72+json, application/vnd.soa.v72+xml

application/vnd.soa.v80+json, application/vnd.soa.v80+xml

application/vnd.soa.v81+json, application/vnd.soa.v81+xml
Cookie AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter Parm Type Data Type Required Description
UserID Path string Required The unique ID for a specific user.

Response

If successful, this operation returns HTTP status code 200, with with information about the groups the specified user is a member of in the form of an RSS feed.

Sample Response

The sample response below shows that the specified user is a member of one user group.

Sample response headers: application/json 

Status Code: 200 OK
Content-Type: application/json
Date: Mon, 20 May 2013 22:20:58 GMT

Sample response body: application/json 

{
  "channel" : {
    "title" : "My Groups",
    "item" : [ {
      "title" : "ACME Payments API UG",
      "description" : "ACME Payments API User Group",
      "category" : [ {
        "value" : "group",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "Limited",
        "domain" : "uddi:soa.com:visibility"
      }, {
        "value" : "com.soa.group.membership.state.approved",
        "domain" : "uddi:soa.com:status"
      }, {
        "value" : "com.soa.group.membership.role.member",
        "domain" : "uddi:soa.com:role"
      } ],
      "guid" : {
        "value" : "group19212.acmepaymentscorp"
      },
      "Image" : {
        "Url" : "https://{hostname}/api/groups/group19212.acmepaymentscorp/avatar",
        "Link" : "../acmepaymentscorp#/groups/group19212.acmepaymentscorp/details"
      }
    } ]
  },
  "version" : "1.0"
}

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type

application/json, text/xml

application/rss+xml

application/vnd.soa.v71+json, application/vnd.soa.v71+xml

application/vnd.soa.v72+json, application/vnd.soa.v72+xml

application/vnd.soa.v80+json, application/vnd.soa.v80+xml

application/vnd.soa.v81+json, application/vnd.soa.v81+xml

Response Body

The response body is in the form of an RSS channel, and includes the items listed below. The RSS version is 1.0. The title of the RSS Channel is My Groups. Each item in the RSS channel represents a group that the specified user is a member of, and includes the information below.

Name Description
title The text title of the group.
description Text description of the group.
category[ ]

An array of sets of two name/value pairs, each including Value and Domain, with a value for each. For example:

"value" : "Limited",
"domain" : "uddi:soa.com:visibility"

The example above indicates that the group has a visibility of limited.
GUID GUID for the group; the GroupID.
image URL to the group's avatar, if applicable. If the group has no custom avatar, the URL to the default group avatar is included. The image information also includes a link to the Details page for the group.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401

Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.

You would also get this response if you hadn't completed login before running the operation, or if you had the wrong UserID.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.