Get User Groups and Product Profiles

GET /v2/usermanagement/groups/{orgId}/{page}

Retrieves a paged list of all user groups and product profiles in your organization along with information about them. You can make multiple paginated calls to retrieve the full list.

Throttle Limits: Maximum 5 requests per minute per a client. See Throttling Limits for full details.

Parameters

Name Type Required Description
orgId path true The unique identifier for an organization. This is a string of the form A495E53@AdobeOrg where the prefix before the @ is a hexadecimal number. You can find this value as part of the URL path for the organization in the Admin Console or in the adobe.io console for your User Management integration.
X-Api-Key header true The API key specified in the Adobe IO Console for the UMAPI integration used to authorize this session. See the Getting Started documentation for details. The header name is X-Api-Key and this parameter is its value.
page path true The 0-based index of the page number being requested. If greater than last page number, returns the last page of groups. The page size is variable with the current value returned in the X-Page-Size response header.
Authorization header true The OAuth token generated by the authorization server from the JWT exchange which starts every UMAPI session. (This token usually begins with the letters ‘ey’.) The header name is Authorization, and this parameter, preceded by the word ‘Bearer’ and a space, is its value, as in Authorization: Bearer ey....
content-type header false Used to specify the content type of the request data. Must be application/json
X-Request-Id header false An arbitrary string used to identify the corresponding response to a request. If a header with this name is provided in the request, the exact same header will be included in the response to that request.

Responses

Content-Type: application/json

:warning: Use only those properties that are documented in the Response Properties section. Additional fields can appear in the response, but should not be relied upon.

200 OK

A successful request returns a response body with the requested group data in JSON format. When the response contains the last paged entry, the response includes the field lastPage : true. If the returned page is not the last page, make additional paginated calls to retrieve the full list.

Examples

Response returning three groups, which is also the last page.

{
  "lastPage": true,
  "result": "success",
  "groups": [
        {
          "type": "SYSADMIN_GROUP",
          "groupName": "Administrators",
          "memberCount": 11
        },
        {
          "type": "USER_GROUP",
          "groupName": "Document Cloud 1",
          "memberCount": 26,
          "adminGroupName": "_admin_Document Cloud 1",
          "licenseQuota": "2"
        },
        {
          "type": "PRODUCT_PROFILE",
          "groupName": "Default Support Profile",
          "memberCount": 0,
          "productName": "All Apps plan - 100 GB",
          "licenseQuota": "8"
        },
        {
          "type": "PRODUCT_ADMIN_GROUP",
          "groupName": "_product_admin_Adobe Document Cloud for business",
          "memberCount": 2,
          "productProfileName": "Adobe Document Cloud for business",
        },
        {
          "type": "DEVELOPER_GROUP",
          "groupName": "_developer_Adobe Document Cloud for business",
          "memberCount": 5,
          "productProfileName": "Adobe Document Cloud for business",
        }
    ]
}

Response to request for an out-of-bounds page number.

{
    "lastPage": true,
    "result": "Not found"
}

Response Properties

A group entry can represent a product profile, a user group, or an administrative group. Different fields are returned for the different types of group. The type field identifies the group type:

  • type: string; The group type. One of:
    • USER_GROUP
    • PRODUCT_PROFILE
    • SYSADMIN_GROUP
    • DEPLOYMENT_ADMIN_GROUP
    • SUPPORT_ADMIN_GROUP
    • PRODUCT_ADMIN_GROUP
    • PROFILE_ADMIN_GROUP
    • USER_ADMIN_GROUP
    • DEVELOPER_GROUP

The following fields are present for all group types:

  • memberCount: integer; The count of all members of the group.
  • adminGroupName string; The name of the group that lists the administrators for this user group or product profile. Field absent if there are no administrators for this user group or product profile. The name is in the format _admin_user-group-name or _admin_product-profile-name.
  • groupName: string; The name of the group (assigned in the Admin Console). There are three administrative groups with fixed names:
    • Administrators: _org_admin
    • Support Administrators: _support_admin
    • Deployment Administrators: _deployment_admin

    In addition, there are administrative groups for each user group and product profile. There are also developer groups for product profiles. These are named with a prefix and the group name. For example, _admin_Marketing Group, _product_admin_Adobe Document Cloud for business or _developer_Marketing Group.

  • groupId: long; The unique identifier for the group.

The following field is returned for groups of type USER_ADMIN_GROUP:

  • userGroupName string; The name of the user group for which this group grants admin rights.

The following field is returned for groups of type PROFILE_ADMIN_GROUP:

  • productProfileName string; The name of the product profile for which this group grants admin rights.

The following fields are returned for groups of type PRODUCT_PROFILE:

  • productName string; The name of the product associated with this product profile.
  • licenseQuota: string; The number of user licenses or the amount of resources alloted to this product profile.

You should avoid any logic that expects fixed group names as these are liable to change without notice.

Schema Model

{
  "type": "string",
  "memberCount": 0,
  "adminGroupName": "string",
  "groupName": "string",
  "userGroupName": "string",
  "productProfileName": "string",
  "productName": "string",
  "licenseQuota": "string",
  "groupId": long
}

400 Bad Request

Some parameters of the request were not understood by the server or the Service Account Integration certificate has expired.

401 Unauthorized

Possible causes are:

  • Invalid or expired token.
  • Invalid Organization.
< HTTP/1.1 401 Unauthorized
< Content-Type: */*
< Date: Thu, 22 Jun 2017 09:47:04 GMT
< WWW-Authenticate: Bearer realm="JIL", error="invalid_token", error_description="The access token is invalid"
< X-Request-Id: user-assigned-request-id
< Content-Length: 0
< Connection: keep-alive

403 Forbidden

Possible causes are:

  • Missing API key.
  • The organization is currently migrating. Either from DMA or to One Console.
  • API key is not permitted access.
< HTTP/1.1 403 Forbidden
< Date: Thu, 22 Jun 2017 09:41:22 GMT
< X-Request-Id: user-assigned-request-id
< Content-Length: 0
< Connection: keep-alive

Example Requests

Retrieve the first page of groups:

curl -X GET https://usermanagement.adobe.io/v2/usermanagement/groups/12345@AdobeOrg/0 \
  --header 'Authorization: Bearer ey...' \
  --header 'X-Api-Key: 88ce03094fe74f4d91c2538217d007fe'

Retrieve the fourth page of groups:

curl -X GET https://usermanagement.adobe.io/v2/usermanagement/groups/12345@AdobeOrg/4 \
  --header 'Authorization: Bearer ey...' \
  --header 'X-Api-Key: 88ce03094fe74f4d91c2538217d007fe'

Throttling

To protect the availability of the Adobe back-end user identity systems, the User Management API imposes limits on client access to the data. Limits apply to the number of calls that an individual client can make within a time interval, and global limits apply to access by all clients within the time period. For this API the throttling limits are as follows:

  • Maximum calls per client: 5 requests per a minute
  • Maximum calls for the application: 100 requests per a minute

When the client or global access limit is reached, further calls fail with HTTP error status 429 Too Many Requests. The Retry-After header is included in the 429 response, and provides the minimum amount of time that the client should wait until retrying. See RFC 7231 for full information.

The User Management API recommends limiting your syncs to two hourly intervals and consider scheduling your sync for a time that works best for you, taking into account other timezones and clients. This will help to prevent how often your client is throttled.

The following sample shows a 429 response with the Retry-After header detailing the number of seconds to wait before retry:

========================= RESPONSE =========================
Status code: 429
-------------------------- header --------------------------
Content-Type: application/json
Date: Fri, 19 Jan 2018 10:31:43 GMT
Retry-After: 38
Server: APIP
X-Request-Id: iEUtsLiFgj3R4xsbirAyZlMyaxRTo8Xo
Content-Length: 54
Connection: keep-alive
--------------------------- body ---------------------------
{
  "error_code" : "429050",
  "message" : "Too many requests"
}
============================================================

Because of the global limits, and because the specific limits may change, you cannot simply limit the rate at which you make your own calls. You must handle rate-limit errors by retrying the failed calls. We recommend an exponential backoff retry technique for handling such errors.

Handling error responses

When you retry a failed request, the retry can also fail, and can fall back into the retry loop, adding to the system overload. The exponential backoff retry method increases the period between retries, so that the client makes fewer calls while the system is overloaded.

To implement an exponential backoff method, you increase the retry interval with each failed request. You should retry sending the request after a certain number of seconds, and increase that interval by a random amount with each attempt. For example, you can double the retry period each time, or escalate it by a power of 2, and then add a small random delay between failures.

A small random delay, known as “jitter,” prevents the “herd effect” that can occur if many clients attempt to reconnect to a recovering system at the same time. Without jitter, all of the retries could occur after 20 seconds, then 40 seconds, and so on. With the jitter, different retries occur at slightly different intervals. This allows the system to recover without further overloading it.

For an example of how to implement this error-handling method, see “Retrying Requests” in the User Management Walkthrough.