tenant
  • Description: Identifies information for a tenant
  • Type: Array of mapped attributes

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

    • Type: String

    resource
    • Description: Unique URL to access this resource.
    • Type: String
    perms (click for additional details)

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

    • Type: String

    Required

    url
    • Description: The URL that is associated with the tenant's marketing website. See the Tenant ID and Tenant Name Dependency section for the relevant release for additional details.

      This is not the URL to access the CloudCenter platform

    • Type: String

    Required

    about
    • Description: Additional information about the tenant organization
    • Type: String

    Required

    contactEmail
    • Description: The contact email address for this tenant organization
    • Type: String

    Required

    phone
    • DescriptionThe phone number for this tenant organization 
    • Type: String
    userId
    • Description: Unique, system-generated identifier for a user
    • Type: String

    termsOfService
    • Description: The text of this contract
    • Type: String

    Required

    privacyPolicy
    • Description: Privacy policy of the tenant organization
    • Type: String

    Required

    shortName
    • Description: Unique short version of this tenant's name to be used in the Login page. See the Tenant ID and Tenant Name Dependency description in the Sub-Tenants section for the relevant release for additional context.
    • Type: String
    • Type: Boolean

    enableEmailNotificationsToUsers
    • Description: Indicates if the invoice email at the end of each month must be sent to tenant users.
      • true = Email messages should be sent to users
      • false = email messages should not be sent to users
    • Type: Boolean
    parentTenantId
    • Description: Unique, system-generated identifier for the parent tenant organization
    • Type: Integer
    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
    defaultActivationProfileId
    • Description: Activation profile ID to use when activating a user if another activation profile ID is not specified. See Map an Activation Profile for additional context.
    • Type: String
    enableMonthlyBilling
    • Description: Indicates whether monthly billing should be enabled for this tenant. See Tenant Billing for additional context.
      • true = Enable monthly billing for this tenant
      • false = Do not enable monthly billing for this tenant
    • Type: Boolean
    defaultChargeType
    • DescriptionThe default charge type for this account.  
    • Type: Enumeration

      EnumerationDescription
      HOURLYDefault, if not included in the request. See Tenant Billing for additional context.
      MONTHLYSee Tenant Billing for additional context.
    • Description: URL of a saved image to be displayed as the logo on the Login page of the CCM uploading logos. See Upload Logo API for additional context.
    • Type: String
    • Description: URL of a saved image to be displayed as the logo on the CCM home page after the user has logged into the CloudCenter platform. See Upload Logo API for additional context.
    • Type: String
    domainName
    • Description: DNS domain name for this tenant organization. Valid characters are letters, numbers, hyphens, and underscores. See Add Sub-TenantsTenant ID and Tenant Name Dependency for additional details. The behavior for this attribute differs based on it being a request or a response:
      • API Request: If the suffix company07.com is present in the CCM property file, and requiredname.company07.com is required dnsName, the domainName attribute should only contain the value requiredname.
      • API Response: The domainName attribute  displays requiredname.company07.com.
    • Type: String

    activationCodes (click for additional details)

    firewallProfiles (click for additional details)

    createUserSecurityGroup
    • Description: Indicates if a security group should be created for each user. See Security and Firewall Rules for additional context.

      Effective CloudCenter 4.8.1, for AWS, Alibaba, and OpenStack clouds, the cliqr-user-security-group_userId security group is created if both createUserSecurityGroup and allowVmConnection are set to true.

    • Type: Boolean
      • false = The existing property to allow unrestricted access across VMs created by this user and the tenant specific firewall rules per cloud are ignored.
      • true = The existing property to allow unrestricted access across VMs created by this user and the tenant specific firewall rules per cloud are honored.

    allowVmConnection
    • Description: Indicates if this user is allowed unrestricted access across VMs and/or if the tenant specific firewall rules per cloud is set. See Security and Firewall Rules for additional context.

      Effective CloudCenter 4.8.1, for AWS, Alibaba, and OpenStack clouds, the cliqr-user-security-group_userId security group is created if both createUserSecurityGroup and allowVmConnection are set to true.

    • Type: Boolean
      • false = The existing property to allow unrestricted access across VMs created by this user and the tenant specific firewall rules per cloud are ignored.
      • true = The existing property to allow unrestricted access across VMs created by this user and the tenant specific firewall rules per cloud are honored.

    preferences (click for additional details)
    user (click for additional details)
    deleted
    • Description: Identifies if this resource is deleted in the CloudCenter platform.
    • Type: Boolean
      • true = The resource is deleted.
      • false = The resource is not deleted.


© 2017-2019 Cisco Systems, Inc. All rights reserved