Product Access APIs

DEPRECATED: These APIs have been deprecated. An exact date for removal will be confirmed before the end of 2017 but you should look to update your scripts as soon as possible.


Product information defined for your organization in the Admin Console is available through the {orgId}/products/ resource. You can list products and examine information for individual products.

  • Get a paged list of products for your organization.
GET /v2/usermanagement/{orgId}/products/
  • Retrieve information for an individual product by its unique ID.
GET /v2/usermanagement/{orgId}/products/{productId}

Request headers

You must include these headers in all requests:

  • Authorization : A current access token obtained from login request.
  • x-api-key : The API key for your organization, obtained from the Developer Portal.

List Products

A GET request to the /{orgId}/products/ resource retrieves a paged list of Adobe products that your organization uses.

GET [UM_Server]/{orgId}/products[?page={n}]
  • {orgId} : Required. The unique ID of your organization.
  • page={n} : Optional, default is 0. A zero-based index for the start entry of a paged response.

Responses

A successful request returns a response with HTTP status 200. The response body contains the requested user data in JSON format:

[
 {
   "id": "XXXX-ABC123456789ABCD",
   "code": "SUPPORT",
   "name": "Support",
   "userCount": 1,
   "configurationCount": 2,
   "licenseQuota": 10
  },
 {
   "id": "YYYY-DEF123456789ABCDE",
   "code": "APAP",
   "name": "Adobe Document Cloud for business",
   "userCount": 202,
   "configurationCount": 1,
   "licenseQuota": 20
  },
 {
   "id": "ZZZZ-GHI123456789ABCDE",
   "code": "CCSV",
   "name": "All Apps plan",
   "userCount": 226,
   "configurationCount": 1,
   "licenseQuota": 10
  }
]

A failed request can result in a response with one of these HTTP status values, with an error message in the response body:

  • 400 Bad Request : Some parameters of the request were not understood by the server.
  • 401 Unauthorized : Invalid or expired token.
  • 403 Forbidden : x-api-key header is missing.
  • 404 Not Found : productId was not found.

Note that server errors can occur that require exponential back-off on retry.

Get Product Information

A GET request to the {orgId}/products/{productId} resource retrieves the product information for an individual Adobe product. The body of the response contains the product information in JSON format.

GET [UM_Server]/{orgId}/products/{productId}
  • {orgId} : Required. Your organization ID.
  • {productId} : Required. The unique ID of the product.

Responses

A successful request returns the requested data with HTTP status 200. The response body contains the requested product data in JSON format.

{
 [
  {
    "id": "XXXX-123456789ABCD",
    "code": "SUPPORT",
    "name": "Support",
    "userCount": 1,
    "configurationCount": 2,
    "licenseQuota": 10
   }
  ]
 }