// removed jquery ui css and js

Update Activation Profile

Details

API Details
Name

Update Activation Profiles by Activation Profile ID

Description
MethodPUT
URIv1/tenants/tenantId/activationProfiles/activationProfileId
CloudCenter ReleaseIntroduced in CloudCenter 4.0.
NotesFor additional context on <PORT> usage in the following example, see Base URI Format.
ESB Headeraction: update.tenants.tenantId.activationProfiles.activationProfileId

Example

curl -k -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/1/activationProfiles"

Request Body

This is a request to update the name (from HMdocs to HMdoc) and description (null value to HM documentation) for the specified profile:

{
  "name": "HMdoc",
  "description": "HM documentation",
} 

Response

{
  "contractId": null,
  "bundleId": null,
  "planId": null,
  "activateRegions": [],
  "agreeToContract": true,
  "importApps": [],
  "sendActivationEmail": false,
  "id": "9",
  "name": "HMdoc",
  "description": "HM documentation",
  "tenantId": 0,
  "resource": "https://<HOST>:<PORT>/v1/tenants/0/activationProfiles/9",
  "depEnvId": "4"
}

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

Required

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

Required

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

  • Type: String

description
  • DescriptionA brief description for this CloudCenter Resource.

  • Type: String

 

Response Attributes

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

 

© 2017 Cisco Systems