customers

Update a customer.

Changed on

Update the details, license, and channel assignments for an existing customer. Supports changing metadata, license type, expiration, entitlements, and feature flags. Parameters that are not provided are reset to default values, except for type, is_enterprise_portal_enabled, is_dev_mode_enabled, and saml_allowed, which preserve their currently stored value instead of resetting it when omitted. is_embedded_cluster_multinode_enabled is also preserved when omitted, but only while is_embedded_cluster_download_enabled is true; otherwise it is reset like any other omitted parameter. Changing type away from "dev" while a customer has dev mode enabled requires explicitly sending is_dev_mode_enabled=false in the same request; otherwise the preserved stored dev-mode value conflicts with the new type and the request is rejected with a 400.

Required RBAC Policy: kots/app/[:appid]/license/[:licenseid]/update

put/customer/{customer_id}

Request

  • Base URL
    https://api.replicated.com/vendor/v3
  • URL
    https://api.replicated.com/vendor/v3/customer/{customer_id}
  • Auth
    API key in header Authorization

Path parameters

customer_idstring required

Customer identifier

Request body

app_idstring required

App to which the channel is associated.

channel_idstring

The channel id to which the customer is associated. This is the default channel for the customer.

custom_idstring

Custom ID that can be used in external systems.

emailstring

Email of the customer that is to be updated

expires_atstring

Format is YYYY-MM-DD, e.g. 2021-02-24

is_airgap_enabledboolean
is_dev_mode_enabledboolean
is_disaster_recovery_supportedboolean
is_embedded_cluster_download_enabledboolean
is_embedded_cluster_multinode_enabledboolean
is_enterprise_portal_enabledboolean
is_geoaxis_supportedboolean
is_gitops_supportedboolean
is_helm_airgap_enabledboolean
is_helm_install_enabledboolean
is_identity_service_supportedboolean
is_kots_install_enabledboolean
is_kurl_install_enabledboolean
is_snapshot_supportedboolean
is_support_bundle_upload_enabledboolean
namestring required

Name of the customer that is to be updated.

saml_allowedboolean

SAML configuration - vendors can enable/disable SAML for customers Customers configure their IdP details via market-api

typestring

Response

GetCustomerResponse represents a customer.

Changes

    • info

      added the new optional request property

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property / to the response with the status