action dracoon_update_customer_attributes {
label: "Add or edit customer attributes"
description: "
🚀 Since v4.4.0
\n\n### Description: \nAdd or edit custom customer attributes.\n
🚧 **Warning: Please note that the response with HTTP status code 200 (OK) is deprecated and will be replaced with HTTP status code 204 (No content)!**
\n\n### Precondition:\nRight 🔓 change global config required.\n\n### Postcondition:\nCustom customer attributes get added or edited.\n\n### Further Information:\nBatch function. \nIf an entry exists before, it will be overwritten. \n\n* Allowed characters for keys are: `[a-zA-Z0-9_-]` \n* Characters are **case-insensitive**."
provider: dracoon
method: PUT
path: "/v4/provisioning/customers/{customer_id}/customerAttributes"
encoding: json
input: {
type: "object"
properties: {
"X-Sds-Date-Format": {
type: "string"
enum: ["UTC", "LOCAL", "OFFSET", "EPOCH", "LEET"]
}
"X-Sds-Service-Token": {
type: "string"
}
customer_id: {
type: "integer"
format: "int64"
}
items: {
type: "array"
description: "List of customer attributes"
items: {
type: "object"
description: "Key-value pair"
required: ["key", "value"]
properties: {
key: {
type: "string"
description: "Entry key"
}
value: {
type: "string"
description: "Entry value"
}
}
}
}
}
required: ["customer_id", "items"]
additionalProperties: false
}
output: {
type: "object"
description: "Customer information"
required: ["cntGuestUser", "cntInternalUser", "companyName", "createdAt", "customerContractType", "customerUuid", "id", "lockStatus", "quotaMax", "quotaUsed", "userMax", "userUsed"]
properties: {
activationCode: {
type: "string"
description: "🚧 Deprecated since v4.8.0\n\nCustomer activation code string:\n\n* valid only for types `free` and `demo`\n\n* for `pay` customers it is empty"
}
cntGuestUser: {
type: "integer"
format: "int32"
description: "Number of guest user accounts"
}
cntInternalUser: {
type: "integer"
format: "int32"
description: "Number of internal user accounts"
}
companyName: {
type: "string"
description: "Company name"
}
createdAt: {
type: "string"
format: "date-time"
description: "Creation date"
}
customerAttributes: {
type: "object"
description: "List of customer attributes"
required: ["items"]
properties: {
items: {
type: "array"
description: "List of customer attributes"
items: {
type: "object"
description: "Key-value pair"
required: ["key", "value"]
properties: {
key: {
type: "string"
description: "Entry key"
}
value: {
type: "string"
description: "Entry value"
}
}
}
}
}
}
customerContractType: {
type: "string"
description: "Customer type"
enum: ["demo", "free", "pay"]
}
customerUuid: {
type: "string"
description: "🚀 Since v4.21.0\n\nCustomer UUID"
}
id: {
type: "integer"
format: "int64"
description: "Unique identifier for the customer"
}
isLocked: {
type: "boolean"
description: "Customer is locked:\n\n* `false` - unlocked\n\n* `true` - locked\n\n\n\nAll users of this customer will be blocked and can not login anymore."
}
lastLoginAt: {
type: "string"
format: "date-time"
description: "Date of last seen login for the customer"
}
lockStatus: {
type: "boolean"
description: "🚧 Deprecated since v4.7.0\n\nCustomer lock status:\n\n* `false` - unlocked\n\n* `true` - locked\n\n\n\nPlease use `isLocked` instead.\n\nAll users of this customer will be blocked and can not login anymore."
}
providerCustomerId: {
type: "string"
description: "Provider customer ID"
}
quotaMax: {
type: "integer"
format: "int64"
description: "Maximal disc space which can be allocated by customer in bytes. -1 for unlimited"
}
quotaUsed: {
type: "integer"
format: "int64"
description: "Used amount of disc space in bytes"
}
trialDaysLeft: {
type: "integer"
format: "int32"
description: "Number of days left for trial period (relevant only for type `demo`)\n\n(not used)"
}
updatedAt: {
type: "string"
format: "date-time"
description: "Modification date"
}
userMax: {
type: "integer"
format: "int32"
description: "Maximal number of users"
}
userUsed: {
type: "integer"
format: "int32"
description: "Number of users which are already allocated."
}
webhooksMax: {
type: "integer"
format: "int64"
description: "🚀 Since v4.19.0\n\nMaximal number of webhooks"
}
}
}
}