List all licenses for a customer

GET /v1/Customers/{customerId}/licenses

Returns a list of licenses for a specific customer. Since this resource is specific to the Microsoft provider, this request is only valid for provider customers that belong to a Microsoft tenant/provider.

Headers

  • X-Tenant string Required

    The domain used to access the portal.

  • Authorization string Required

    JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

    Default value is Bearer eyJ0eXAiO....

  • X-Correlation-Id string(UUID)

    This header is optional and by setting it you can correlate the audit logs made by this request.

Path parameters

  • customerId string(uuid) Required

    GUID Unique identifier for the customer.

Query parameters

  • providerInstanceId string(uuid) Required

    GUID Unique identifier for the provider instance.

  • resellerId string(uuid)

    GUID Unique identifier for the resellerId. By setting this property the licenses will be scoped to that relationship. If user is reseller this property will be auto-populate.

Responses

GET /v1/Customers/{customerId}/licenses
curl \
 -X GET https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Customers/{customerId}/licenses?providerInstanceId=string \
 -H "X-Tenant: portal.cloudcockpit.com" \
 -H "Authorization: Bearer eyJ0eXAiO..." \
 -H "X-Correlation-Id: string"
Response examples (200)
[
  {
    "skuId": "string",
    "name": "string",
    "availableLicenses": 42,
    "isSelected": true,
    "totalLicenses": 42,
    "consumedLicenses": 42,
    "suspendedLicenses": 42
  }
]
Response examples (200)
[
  {
    "skuId": "string",
    "name": "string",
    "availableLicenses": 42,
    "isSelected": true,
    "totalLicenses": 42,
    "consumedLicenses": 42,
    "suspendedLicenses": 42
  }
]
Response examples (400)
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}
Response examples (400)
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}
Response examples (404)
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}
Response examples (404)
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}
Response examples (500)
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}
Response examples (500)
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}