This API can be used to disable a user. Disabling a user will also disable the API key, persisted queries and DMP audience segments belonging to the user.
This API allows customer admin users to update user configuration for a single user.
The user must be authenticated and have customer admin rights.
Request
The request object has the following fields:
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
|
String |
Yes |
User name. |
|
|
Object |
No |
If specified, changes the configuration of the given feature. |
Feature
The feature object has the following fields:
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
|
String |
Yes |
Name of feature. |
|
|
Boolean |
No |
True if the feature is enabled, false otherwise. |
Feature names
|
Name |
Description |
|---|---|
|
|
Gives the user admin rights locally within the customer object. |
|
|
Disable the user. The user will no longer be able to log in or access any data. See warning above |
|
|
Allow the user to store persisted queries. |
|
|
Allow the user access APIs with API key. (New feature, see details below) |
Response
The response has the user object:
See /user/read for details about the user object.
Examples
$ cx.py /user/update '{"username":"some.user@example.com", "feature":{"feature":"customerAdmin", "enabled":true}}'
{
"username": "some.user@example.com",
"customer": "1234567890123456789012345678908123456789",
"customerId": "1234567890123456789012345678908123456789",
"features": [],
"enabledFeatures": [
{
"feature": "customerAdmin",
"enabled": true
},
{
"feature": "patternMatching",
"enabled": true
},
{
"feature": "largeSegments",
"enabled": true
},
{
"feature": "content",
"enabled": true
},
{
"feature": "contentDmpEvents",
"enabled": true
},
{
"feature": "dmp",
"enabled": true
},
{
"feature": "conversionEngine",
"enabled": true
},
{
"feature": "segmentReporting",
"enabled": true
},
{
"feature": "segmentReporting",
"enabled": true,
"parameter": "by-customer"
}
],
"createdTime": "2019-11-25T16:21:58.029Z",
"createdBy": "foo@bar.com",
"lastChangedAt": "2019-11-25T16:22:58.029Z",
"lastUpdatedBy": "example@bar.com"
}