Sign in
User Management

Retrieve a specific user by ID.

Changed on
get/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

Response

Node of the requested user.

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

themestring required

Theme of the User

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",
  "theme": "default",
  "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,
    "totalItems": 666
  },
  "perspectives": [
    {
      "id": "5026c239_eb75_499a_8576_841bca283350",
      "name": "Cars",
      "icon": {
        "type": "path",
        "value": "/path/to/icon"
      },
      "isWriteable": true
    }
  ]
}

Changes

  • 81b097a1505fRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the required property to the response with the status