Sign in
User Management

user_update_by_id_summary

put/pimcore-studio/api/user/{id}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pimcore-studio/api/user/{id}
  • Auth: none declared

Path parameters

idinteger required
Example:83

Id of the User

Request body

emailstring nullable required

Email of the User

firstnamestring nullable required

Firstname of the User

lastnamestring nullable required

Lastname of the User

adminboolean required

If User is admin

activeboolean required

If User is active

classesobject required

Classes the user is allows to see

docTypesobject required

Allowed Document types to create

closeWarningboolean required

Show Close Warning

allowDirtyCloseboolean required

Allow Dirty Close

contentLanguagesobject required

List of available content Language already sorted.

languagestring required

Language of the User

dateTimeLocalestring

Date Time Locale for the User

memorizeTabsboolean required

Memorize Tabs

parentIdinteger required

Parent ID

permissionsobject required

List of permissions for the user

rolesobject required

ID List of roles the user is assigned

twoFactorAuthenticationRequiredboolean required

Two Factor Authentication Enabled

websiteTranslationLanguagesEditobject required

Website Translation Languages Edit

websiteTranslationLanguagesViewobject required

Website Translation Languages View

welcomeScreenboolean required

Show welcome Screen

perspectivesobject required

Allowed studio perspectives

Example request

{
  "active": true,
  "closeWarning": true,
  "allowDirtyClose": true,
  "keyBindings": [
    {
      "action": "save"
    }
  ],
  "language": "de",
  "memorizeTabs": true,
  "parentId": 2,
  "welcomeScreen": true,
  "assetWorkspaces": [
    {
      "cpath": "/path/to/element",
      "list": true,
      "view": true,
      "publish": true,
      "delete": true,
      "rename": true,
      "create": true,
      "settings": true,
      "versions": true,
      "properties": true
    }
  ],
  "dataObjectWorkspaces": [
    {
      "cpath": "/path/to/element",
      "list": true,
      "view": true,
      "publish": true,
      "delete": true,
      "rename": true,
      "create": true,
      "settings": true,
      "versions": true,
      "properties": true
    }
  ],
  "documentWorkspaces": [
    {
      "cpath": "/path/to/element",
      "list": true,
      "view": true,
      "publish": true,
      "delete": true,
      "rename": true,
      "create": true,
      "settings": true,
      "versions": true,
      "properties": true
    }
  ]
}

Response

user_update_by_id_success_response

additionalAttributesobject

AdditionalAttributes

idinteger required

ID of the User

namestring nullable required

Name of Folder or User

emailstring nullable required

Email of the User

firstnamestring nullable required

Firstname of the User

lastnamestring nullable required

Lastname of the User

activeboolean required

If a User is active

adminboolean required

If User is admin

classesobject required

Classes the user is allows to see

docTypesstring[] required

Allowed doc types to create

closeWarningboolean required

Show close warning

allowDirtyCloseboolean required

Allow Dirty Close

contentLanguagesobject required

List of available content Language already sorted.

hasImageboolean required

If User has an Image

languagestring required

Language of the User

dateTimeLocalestring nullable

Locale for dateTime

lastLogininteger nullable

Timestamp of the last login

memorizeTabsboolean required

Memorize Tabs

parentIdinteger nullable required

Parent ID

permissionsobject required

List of permissions for the user

rolesobject required

ID List of roles the user is assigned

websiteTranslationLanguagesEditobject required

Website Translation Languages Edit

websiteTranslationLanguagesViewobject required

Website Translation Languages View

welcomeScreenboolean required

Show Welcome Screen

Example response

{
  "name": "admin",
  "active": true,
  "closeWarning": true,
  "allowDirtyClose": true,
  "hasImage": true,
  "keyBindings": [
    {
      "action": "save"
    }
  ],
  "language": "de",
  "memorizeTabs": true,
  "parentId": 2,
  "twoFactorAuthentication": {
    "required": true,
    "enabled": true,
    "type": "totp",
    "active": true
  },
  "welcomeScreen": true,
  "assetWorkspaces": [
    {
      "cpath": "/path/to/element",
      "list": true,
      "view": true,
      "publish": true,
      "delete": true,
      "rename": true,
      "create": true,
      "settings": true,
      "versions": true,
      "properties": true
    }
  ],
  "dataObjectWorkspaces": [
    {
      "cpath": "/path/to/element",
      "list": true,
      "view": true,
      "publish": true,
      "delete": true,
      "rename": true,
      "create": true,
      "settings": true,
      "versions": true,
      "properties": true,
      "save": true,
      "unpublish": true,
      "localizedEdit": "default",
      "localizedView": "default",
      "layouts": "CAR"
    }
  ],
  "documentWorkspaces": [
    {
      "cpath": "/path/to/element",
      "list": true,
      "view": true,
      "publish": true,
      "delete": true,
      "rename": true,
      "create": true,
      "settings": true,
      "versions": true,
      "properties": true,
      "save": true,
      "unpublish": true
    }
  ],
  "objectDependencies": {
    "dependencies": [
      {
        "id": 42,
        "path": "/path/to/object",
        "subtype": "Car"
      }
    ],
    "hasHidden": true
  },
  "perspectives": [
    {
      "id": "5026c239_eb75_499a_8576_841bca283350",
      "name": "Cars",
      "icon": {
        "type": "path",
        "value": "/path/to/icon"
      },
      "isWriteable": true
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.