Sign in
User Management

Update the current user profile

Changed on

Update the current user profile. <br> See the full description of updatable fields with the schema <strong>UpdateUserProfile</strong>

put/pimcore-studio/api/user/update-profile

Request

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

Request body

firstnamestring nullable required

Firstname of the User

lastnamestring nullable required

Lastname of the User

emailstring nullable required

Email of the User

languagestring required

Language of the User

dateTimeLocalestring nullable required

Date Time Locale for the User

welcomeScreenboolean required

Show Welcome Screen

memorizeTabsboolean required

Memorize Tabs

contentLanguagesobject required

List of available content Language already sorted.

themestring

Theme of the User

Example request

{
  "language": "de",
  "welcomeScreen": true,
  "memorizeTabs": true,
  "keyBindings": [
    {
      "action": "save"
    }
  ],
  "theme": "default"
}

Response

Successfully updated user profile

additionalAttributesobject

AdditionalAttributes

idinteger required

User ID

usernamestring required

Username

emailstring nullable required

Email

firstnamestring nullable required

Firstname

lastnamestring nullable required

Lastname

permissionsstring[] required

Permissions

isAdminboolean required

If user is an admin user

classesstring[] required

Allowed classes to create

docTypesstring[] required

Allowed doc types to create

languagestring required

User Language

dateTimeLocalestring nullable required

Locale for dateTime

themestring required

Theme of the User

welcomeScreenboolean required

Welcome Screen

memorizeTabsboolean required

Memorize Tabs

allowDirtyCloseboolean required

Allow Dirty Close

hasImageboolean required

Has Image

contentLanguagesobject required

List of available content Language already sorted.

allowedLanguagesForEditingWebsiteTranslationsstring[] required

List of valid website Languages to edit.

allowedLanguagesForViewingWebsiteTranslationsstring[] required

List of valid website Languages to view.

activePerspectivestring nullable required

Active studio perspective ID

Example response

{
  "id": 1,
  "username": "admin",
  "permissions": [
    "clear_cache"
  ],
  "language": "en",
  "theme": "default",
  "welcomeScreen": true,
  "memorizeTabs": true,
  "allowDirtyClose": true,
  "hasImage": true,
  "allowedLanguagesForEditingWebsiteTranslations": [
    "de",
    "en"
  ],
  "allowedLanguagesForViewingWebsiteTranslations": [
    "de",
    "en"
  ],
  "keyBindings": [
    {
      "action": "save"
    }
  ],
  "twoFactorAuthentication": {
    "required": true,
    "enabled": true,
    "type": "totp",
    "active": true
  },
  "activePerspective": "studio_default_perspective",
  "perspectives": [
    {
      "id": "5026c239_eb75_499a_8576_841bca283350",
      "name": "Cars",
      "icon": {
        "type": "path",
        "value": "/path/to/icon"
      },
      "isWriteable": true
    }
  ]
}

Changes

  • 81b097a1505fRevision changes
    • info

      added the new optional request property

    • info

      the request property became nullable

    • info

      added the required property to the response with the status