// removed jquery ui css and js

View Activation Profiles

Details

API Details
Name

View Activation Profiles

Description
MethodGET
URI
  • v1/tenants/tenantId/activationProfiles
  • v1/tenants/tenantId/activationProfiles/activationProfileId
CloudCenter ReleaseIntroduced in CloudCenter 4.0.
Notes
  • For additional context on <PORT> usage in the following example, see Base URI Format.
  • The CloudCenter GET APIs display up to 20 entities in the listing by default. If you have more than 20 entities in your resource listing, use the pagination query parameters to view them beyond the first 20 entities returned by default. See the CloudCenter API Overview  > Pagination  section for additional context.
  • If you include an activationProfileId to identify an activation profile, the response includes information for that activation profile only.
ESB Header
  • action: get.tenants.tenantId.activationProfiles
  • action: get.tenants.tenantId.activationProfiles.activationProfileId

Example

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/5/activationProfiles"

Response

 {
  "resource": "https://<HOST>:<PORT>/v1/tenants/5/activationProfiles",
  "size": 2,
  "pageNumber": 0,
  "totalElements": 2,
  "totalPages": 1,
  "activationProfiles": [
    {
      "contractId": null,
      "bundleId": null,
      "planId": null,
      "activateRegions": [
        {
          "regionId": "1"
        }
      ],
      "agreeToContract": true,
      "importApps": [],
      "sendActivationEmail": false,
      "id": "4",
      "name": "CCdocs",
      "description": "",
      "tenantId": 5,
      "resource": https://<HOST>:<PORT>/v1/tenants/5/activationProfiles/4,
      "depEnvId": "4"
    },
    {
      "contractId": null,
      "bundleId": null,
      "planId": null,
      "activateRegions": [
        {
          "regionId": "1"
        }
      ],
      "agreeToContract": true,
      "importApps": [],
      "sendActivationEmail": false,
      "id": "5",
      "name": "PR Docs",
      "description": "",
      "tenantId": 5,
      "resource": https://<HOST>:<PORT>/v1/tenants/5/activationProfiles/5,
      "depEnvId": "5"
    }
  ]
}

Request Attributes

tenantId
  • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

  • Type: String
activationProfileId
  • Description: Unique, system-generated identifier for the activationProfile
  • Type: String

Response Attributes

activationProfiles
  • Description: Identifies the activation profile details
  • Type: Array of activation profiles

    contractId
    • DescriptionUnique, system-generated identifier for a contract belonging to this tenant.
    • Type: String
    bundleId
    • Description: Unique, system-generated identifier for the bundle belonging to this tenant.
    • Type: String
    planId 
    • DescriptionUnique, system-generated identifier for the plan belonging to this tenant. The default is Null.
    • Type: String
    activateRegions
    • Description: Cannot be an empty array, needs to have at least one entry in the array with a valid cloud region's regionId value.
    • Type: Array of key-value pairs (of type map)

      regionId
      • DescriptionUnique, system-generated identifier for the cloud region 
      • Type: String

    Required.

    agreeToContract
    • Description: Indicates whether the user has agreed to the tenant organization contract.

      • true = The user has agreed to the tenant organization contract 
      • false = Default. The user has not agreed to the tenant organization contract
    • Type: Boolean

    importApps
    • Description: Array of unique identifiers for applications from the tenant Marketplace that will be made available to this user on activation. The default is an empty array.
    • Type: String (array)
    sendActivationEmail
    • Description: Indicates whether the system sends an email message to the activated user.

      • true = The system sends an email message on user activation
      • false = Default. The system does not send an email message on user activation
    • Type: Boolean
    id
    • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

    • Type: String
    name
    • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

    • Type: String

    Required

    description
    • DescriptionA brief description for this CloudCenter Resource.

    • Type: String

    tenantId
    • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

    • Type: String

    Required

    depEnvId
    • DescriptionUnique, system-generated identifier for the deployment environment. See Deployment Environments for additional details. This attribute is the same as the environmentId attribute.
    • Type: String

    Required