Perform Tenant Actions

Details

API Details
Name

Perform Tenant Actions (Asynchronous API)

Description

Identifies actions that users can perform within a tenant (at least one attribute is required).

This API is useful when you promote a user to be the tenant owner admin. All actions are subject to having the required permissions (see Permission Control for additional context).

Provides a HTTP Location URL that you can use to query the system until this call returns a success or failure HTTP Status Codes.

MethodPOST
URI/v1/users/userId
CloudCenter ReleaseIntroduced in CloudCenter 4.0.
Notes

API Notes:

Assign Tenant Actions Notes:

  • Unspecified attributes are not changed.
ESB Headeraction: create.users.userId

Example

curl -k -X POST -H "Accept: application/json" -H "Content-Type: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/users/userId" 

Request Body Examples

Example 1 – To Manage Cloud Configurations

{
   "action":"MANAGE_CLOUDS",
   "activateRegions":[
      {
         "regionId":"3"
      }
   ]
}

Example 2 – To Manage Plans for Tenant

Performed by the tenant owner admin.

 {
    "action": "MANAGE_PLANS",
    "userManagePlansData": {
        "planId": "4",
        "contractId": "1",
        "type": "CHANGE_PRORATE",
        "renewContract": false,
        "userId": 15
    }
}

Example 3 – To Disable a Tenant

{
    "id": "15",
    "username": "user.04_f",
    "enabled": false,
    "type": "STANDARD",
    "firstName": "User 04",
    "lastName": "Cloudcenter",
    "companyName": "Company07, Inc",
    "tenantId": "1",
    "emailAddr": "user.04@Company07.com",
    "phoneNumber": "18005536387",
    "externalId": "",
    "accountSource": "AdminCreated"
}

Example 4 – To Enable a Disabled Tenant

{
    "id": "15",
    "username": "user.04_f",
    "enabled": false,
    "type": "STANDARD",
    "firstName": "User 04",
    "lastName": "CloudCenter",
    "companyName": "Company07, Inc",
    "tenantId": "1",
    "emailAddr": "user.04@Company07.com",
    "phoneNumber": "18005536387",
    "externalId": "",
    "accountSource": "AdminCreated"
}

Example 5 – Tenant Admin (Owner) Activates User's Payment Profile

The user must be activated for this operation to succeed. A successful request results in a HTTP 204 status.

{
    "action": "ACTIVATE_PAYMENT_PROFILE"
} 

Example 6 – Tenant Admin (Owner) Deactivates User's Payment Profile

The user must be activated for this operation to succeed. A successful request results in a HTTP 204 status.

{
    "action": "DEACTIVATE_PAYMENT_PROFILE"
} 

Example 7 – Assign Bundle to a Tenant

A successful request results in a HTTP 204. Currently, this operation is performed on the tenant owner admin who is a proxy for the tenant.

{
    "action": "BUNDLE_CREDIT",
    "bundleCreditData": {
        "bundleId": "1"
    }
} 

Response for All Requests

A success or failure HTTP Status Code.

See HTTP Location URL for the link to the newly created user resource.

Request Attributes

action
  • Description: Allows administrators to perform administrator tasks. See Manage Admin Users for additional context.
  • Type: Enumeration

    Enumeration DescriptionApplicable APIs
    ACTIVATEAllows newly-added users to begin using the CloudCenter platform. See Create Standard Users for additional context.Perform User Actions
    IMPORT_APPSAllows users to import application profiles. See Import Application Profiles for additional context.
    RESET_PASSWORDIssues a new password and sends an email listing the new password to the user. Effective Cloud Center 4.6.1, the CloudCenter platform enforces a minimum password length of 5 characters for all settings.
    See Reset Password for additional context.
    CONVERT_TO_TENANT_ADMINThe primary administrator can promote a Standard User to be a co-administrator at the same level. The co-admin will have the same privileges as the primary administrator. See Manage Admin Users for additional context.
    CONVERT_TO_STANDARD_USERAdministrators can convert another administrator back to being a Standard User. See Manage Admin Users for additional context.
    ADMIN_RESET_PASSWORDOnly a Platform Administrator (Root) or the SysAdmin can change their respective passwords using this API. All other users (including tenant owners) must have the password reset by the admin. Effective Cloud Center 4.6.1, the CloudCenter platform enforces a minimum password length of 5 characters for all settings.
    See Manage Admin Users for additional context.
    ACTIVATE_USING_ACTIVATION_PROFILEAdministrators can activate new users using the activationProfileId so they can begin using the CloudCenter platform. See Activation Profiles for additional context.
    MANAGE_CLOUDSAllows users to manage various cloud configurations in concert. See Clouds for additional context.
    MANAGE_PLANSAllows users to assign plans and contracts. See Configure Bundles for additional context.
    ACTIVATE_PAYMENT_PROFILEActivates the payment profile for this user. See Financial Overview for additional context.
    DEACTIVATE_PAYMENT_PROFILEDe-activates the payment profile for this user. See Financial Overview for additional context.
    BUNDLE_CREDITLimits the user to the bundle credit plan. See Financial Overview for additional context. Requires the bundleCreditData attribute.
manageCloudsData

Click for additional details

userManagePlansData

Click for additional details

bundleCreditData

Click for additional details

id
  • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

  • Type: String
username
  • Description: Unique, CloudCenter-generated name reference for this user.
  • Type: String
enabled
  • Description: Indicates that this resource has been enabled.

    • true = resource has been enabled
    • false = resource has not been enabled (default)
  • Type: Boolean
type
  • DescriptionThe type of resource
  • Type: String
firstName
  • DescriptionCloudCenter user's first name. Defaults to empty string if not set.
  • Type: String
lastName
  • DescriptionCloudCenter user's last name. Defaults to empty string if not set.
  • Type: String
companyName
  • Description: The company name for this user. The default is an empty string.
  • 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
emailAddr
  • Description: Unique (in the system) email address for this resource and must match the regular expression
  • Type: String
phoneNumber
  • Description: The phone number for this user. Defaults to empty string if not set.
  • Type: String
externalId
  • DescriptionIdentity provider ID for external access (for example, SSO). This value must match the corresponding user's SAML subject Name ID value. Defaults to empty string if not set.
  • Type: String
accountSource
  • Description: Indicates how this user account was created (system generated)
  • Type: Enumeration

    EnnumerationDescription
    adminCreated The account was created by an administrator
    selfActivated 

    The account was created by a user by using a self sign-up form

Response Attributes

None