Customers

Contents

Customers

Customer represents accounts of organizations on the platform.

List customers

GET /v3/admin/customers

It lists the customers belonging to the IMCO reseller.

Inputs

None

Returns

An array of customers, with the following fields:

Field Type Description
id String Identifier of the customer.
name String The logical name for the customer.
external_id String Id of the customer on the hub to which the customer belongs.
licensing_enabled Boolean Flag indicating if licensing is enabled for this customer.
admin Boolean Flag indicating whether the customer is the admin customer of the IMCO Reseller.
skin_names Array of strings List of names of the different skins that should be applied to show the platform's UI for customer users. The platform applies to the UI the skin belonging to the reseller with the first name on this list for which there is a match.
resource_type String An identifier for the type of resource, specifically "customer" (from 7.3 onwards).

Back to top

Show customer

GET /v3/admin/customers/:id

It shows information about a customer.

Inputs

None

Returns

A customer with the following fields:

Field Type Description
id String Identifier of the customer.
name String The logical name for the customer.
admin Boolean Flag indicating whether the customer is the admin customer of the IMCO Reseller.
external_id String Id of the customer on the hub to which the customer belongs.
licensing_enabled Boolean Flag indicating if licensing is enabled for this customer.
skin_names Array of strings List of names of the different skins that should be applied to show the platform's UI for the customer users. The platform applies to the UI the skin belonging to the reseller with the first name on this list for which there is a match.
resource_usage Object A dictionary relating the id of each customer's cloud account to counters of resources in use. Currently the only counter is the number of servers under the "servers" key.
resource_type String An identifier for the type of resource, specifically "customer" (from 7.3 onwards).

Back to top

Create customer

POST /v3/admin/customers

It creates a customer belonging to the IMCO reseller.

Inputs

Field Type Description Required
name String The logical name for the customer. Yes
skin_names Array of strings List of names of the different skins that should be applied to show the platform's UI for customer users. The platform applies to the UI the skin belonging to the reseller with the first name on this list for which there is a match. No
external_id String Id of the customer on the hub to which the customer belongs. No
licensing_enabled Boolean Flag indicating if licensing is enabled for this customer. No

Returns

A customer with the following fields:

Field Type Description
id String Identifier of the customer.
name String The logical name for the customer.
admin Boolean Flag indicating whether the customer is the admin customer of the IMCO Reseller.
external_id String Id of the customer on the hub to which the customer belongs.
licensing_enabled Boolean Flag indicating if licensing is enabled for this customer.
skin_names Array of strings List of names of the different skins that should be applied to show the platform's UI for customer users. The platform applies to the UI the skin belonging to the reseller with the first name on this list for which there is a match.
resource_usage Object A dictionary relating the id of each customer's cloud account to counters of resources in use. Currently, the only counter is the number of servers under the "servers" key.
resource_type String An identifier for the type of resource, specifically "customer" (from 7.3 onwards).

Back to top

Update customer

PUT /v3/admin/customers/:id

It updates the name and/or skin names of a customer belonging to the IMCO reseller.

Inputs

Field Type Description Required
name String The logical name for the customer. No
external_id String Id of the customer on the hub to which the customer belongs. No
licensing_enabled Boolean Flag indicating if licensing is enabled for this customer. No
skin_names Array of strings List of names of the different skins that should be applied to show the platform's UI for customer users. The platform applies to the UI the skin belonging to the reseller with the first name on this list for which there is a match. No

Returns

A customer with the following fields:

Field Type Description **
id String Identifier of the customer.  
name String The logical name for the customer.  
admin Boolean Flag indicating whether the customer is the admin customer of the IMCO Reseller.  
external_id String Id of the customer on the hub to which the customer belongs. No
licensing_enabled Boolean Flag indicating if licensing is enabled for this customer. No
skin_names Array of strings List of names of the different skins that should be applied to show the platform's UI for customer users. The platform applies to the UI the skin belonging to the reseller with the first name on this list for which there is a match.  
resource_usage Object A dictionary relating the id of each customer's cloud account to counters of resources in use. Currently, the only counter is the number of servers under the "servers" key.  
resource_type String An identifier for the type of resource, specifically "customer" (from 7.3 onwards).  

Back to top

Destroy customer

DELETE /v3/admin/customers/:id

It deletes a customer belonging to the IMCO reseller. All its resources will be deleted from the platform (though not decommissioned from the cloud).

Inputs

None

Returns

None

Back to top

List allowed cloud providers of customer

GET /v3/admin/customers/:customer_id/cloud_providers

It lists the cloud providers allowed to the customer with the given ID.

Inputs

None

Returns

An array of cloud providers with the following fields:

Field Type Description
id String Identifier of the cloud provider.
name String Name of the cloud provider.
disambiguation String Continuation of the cloud provider name with disambiguation purposes, it is only of use in the context of admin integrations
required_credentials Array of Strings The list of credentials parameters needed to create a cloud account for this provider.
discoverable Boolean Flag to indicate whether the cloud provider can discover cloud accounts for this cloud provider.
cse_syntax String Syntax used to deploy CSE deployments on this cloud provider.
standalone_incompatible Boolean Flag indicating whether this cloud provider can be standalone (false) or not (true).
resource_type String An identifier for the type of resource, specifically "cloud_provider".

Back to top