> For the complete documentation index, see [llms.txt](https://developer.vario-software.de/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.vario-software.de/api-reference/user.md).

# User

Manage users in VARIO Cloud via the REST API, including user data, permissions, settings, signatures, favorites, activation and deactivation.

User.

## GET /cmn/users/{id}/signature/{signatureId}

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/{id}/signature/{signatureId}":{"get":{"tags":["User"],"operationId":"getSignature","parameters":[{"name":"id","in":"path","description":"User identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"signatureId","in":"path","description":"Signature identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-output-OutputSignature"}}}}}}}},"components":{"schemas":{"common-output-OutputSignature":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"contentType":{"type":"string","description":"ContentType","enum":["TEXT","HTML"]},"content":{"type":"string","description":"Content"}},"required":["contentType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## PUT /cmn/users/{id}/signature/{signatureId}

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/{id}/signature/{signatureId}":{"put":{"tags":["User"],"operationId":"updateSignature","parameters":[{"name":"id","in":"path","description":"User identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"signatureId","in":"path","description":"Signature identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputSignature"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-output-OutputSignature"}}}}}}}},"components":{"schemas":{"common-output-OutputSignature":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"contentType":{"type":"string","description":"ContentType","enum":["TEXT","HTML"]},"content":{"type":"string","description":"Content"}},"required":["contentType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## DELETE /cmn/users/{id}/signature/{signatureId}

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/{id}/signature/{signatureId}":{"delete":{"tags":["User"],"operationId":"deleteSignature","parameters":[{"name":"id","in":"path","description":"User identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"signatureId","in":"path","description":"Signature identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}}}}
```

## GET /cmn/users/{id}/favorites/subscription/{subscriptionId}

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/{id}/favorites/subscription/{subscriptionId}":{"get":{"tags":["User"],"operationId":"getSubscriptionFavorite","parameters":[{"name":"id","in":"path","description":"User identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"subscriptionId","in":"path","description":"Output favorite identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-user-UserSubscriptionFavorite"}}}}}}}},"components":{"schemas":{"common-user-UserSubscriptionFavorite":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"refKey":{"type":"string","description":"Data type."},"eventTypes":{"type":"array","description":"Event-Types","items":{"type":"string","description":"Event-Types"}}},"required":["eventTypes","refKey"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## PUT /cmn/users/{id}/favorites/subscription/{subscriptionId}

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/{id}/favorites/subscription/{subscriptionId}":{"put":{"tags":["User"],"operationId":"updateSubscriptionFavorite","parameters":[{"name":"id","in":"path","description":"User identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"subscriptionId","in":"path","description":"Output favorite identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-user-UserSubscriptionFavorite"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-user-UserSubscriptionFavorite"}}}}}}}},"components":{"schemas":{"common-user-UserSubscriptionFavorite":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"refKey":{"type":"string","description":"Data type."},"eventTypes":{"type":"array","description":"Event-Types","items":{"type":"string","description":"Event-Types"}}},"required":["eventTypes","refKey"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## DELETE /cmn/users/{id}/favorites/subscription/{subscriptionId}

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/{id}/favorites/subscription/{subscriptionId}":{"delete":{"tags":["User"],"operationId":"deleteSubscriptionFavorite","parameters":[{"name":"id","in":"path","description":"User identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"subscriptionId","in":"path","description":"Output favorite identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}}}}
```

## GET /cmn/users/{id}/favorites/outputs/{favoriteId}

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/{id}/favorites/outputs/{favoriteId}":{"get":{"tags":["User"],"operationId":"getOutputFavorite","parameters":[{"name":"id","in":"path","description":"User identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"favoriteId","in":"path","description":"Output favorite identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-user-UserOutputFavorite"}}}}}}}},"components":{"schemas":{"common-user-UserOutputFavorite":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"moduleRef":{"$ref":"#/components/schemas/common-output-OutputModuleRef"},"outputModuleRule":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"sourceOutputTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetOutputTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetReportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetOutputConsumerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"outputQuantity":{"type":"integer","format":"int32","description":"Number of outputs.","minimum":1},"targetOutputConsumerResult":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["moduleRef","userRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"common-output-OutputModuleRef":{"description":"print module key","properties":{"key":{"type":"string","description":"output module key"},"label":{"type":"string","description":"output module label"}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}}}}}
```

## PUT /cmn/users/{id}/favorites/outputs/{favoriteId}

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/{id}/favorites/outputs/{favoriteId}":{"put":{"tags":["User"],"operationId":"updateOutputFavorite","parameters":[{"name":"id","in":"path","description":"User identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"favoriteId","in":"path","description":"Output favorite identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-user-UserOutputFavorite"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-user-UserOutputFavorite"}}}}}}}},"components":{"schemas":{"common-user-UserOutputFavorite":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"moduleRef":{"$ref":"#/components/schemas/common-output-OutputModuleRef"},"outputModuleRule":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"sourceOutputTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetOutputTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetReportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetOutputConsumerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"outputQuantity":{"type":"integer","format":"int32","description":"Number of outputs.","minimum":1},"targetOutputConsumerResult":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["moduleRef","userRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"common-output-OutputModuleRef":{"description":"print module key","properties":{"key":{"type":"string","description":"output module key"},"label":{"type":"string","description":"output module label"}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}}}}}
```

## DELETE /cmn/users/{id}/favorites/outputs/{favoriteId}

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/{id}/favorites/outputs/{favoriteId}":{"delete":{"tags":["User"],"operationId":"deleteOutputFavorite","parameters":[{"name":"id","in":"path","description":"User identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"favoriteId","in":"path","description":"Output favorite identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}}}}
```

## PUT /cmn/users/{id}/deactivate

> Deactivate an existing resource

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/{id}/deactivate":{"put":{"tags":["User"],"summary":"Deactivate an existing resource","operationId":"deactivate_59","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-user-User"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-user-User":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"Is the user active?","readOnly":true},"username":{"type":"string","description":"username"},"firstName":{"type":"string","description":"first-name"},"lastName":{"type":"string","description":"last-name"},"emailAddress":{"type":"string","description":"email-address"},"owner":{"type":"boolean","default":false,"description":"Is owner user?","readOnly":true},"emailVerified":{"type":"boolean","default":false,"description":"is the email verified","readOnly":true},"validTo":{"type":"string","format":"date-time","description":"Valid to"},"type":{"type":"string","description":"User type","enum":["REGULAR","SUPPORT","SYSTEM","LIMITED_WMS","LIMITED_POS","LIMITED_DASHBOARD","LIMITED_AGENT","APP_BUILTIN_USER"]},"roles":{"type":"array","description":"Roles.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"groups":{"type":"array","description":"Groups.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"appIdentifier":{"type":"string","format":"uuid","description":"App-Identifier","readOnly":true},"referencedCustomerUserId":{"type":"integer","format":"int64","description":"Referenced customer user identifier (CustomerUserEntity.id from vab-manager).","readOnly":true}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Search dialogs to use.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Search dialogs to use.","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Key for the search dialog result.","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}}}}}
```

## GET /cmn/users/{id}/authorization

> Provides the authorizations for a given user

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/{id}/authorization":{"get":{"tags":["User"],"summary":"Provides the authorizations for a given user","operationId":"readUserPermissionByUserId","parameters":[{"name":"id","in":"path","description":"User identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-user-UserPermissionRead"}}}}}}}},"components":{"schemas":{"common-user-UserPermissionRead":{"properties":{"superUser":{"type":"boolean","default":false,"description":"is user superuser?","readOnly":true},"operations":{"type":"array","description":"list of operations","items":{"$ref":"#/components/schemas/common-user-UserPermissionRead.RolePermissionWithOrigin"},"readOnly":true}}},"common-user-UserPermissionRead.RolePermissionWithOrigin":{"description":"list of operations","properties":{"permission":{"$ref":"#/components/schemas/common-user-RolePermission"},"virtual":{"type":"boolean","default":false,"description":"virtual permission?","readOnly":true},"obtainedByRoles":{"type":"array","description":"Roles that brought this permission.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"obtainedByGroups":{"type":"array","description":"Groups that brought this permission.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true}}},"common-user-RolePermission":{"description":"the operation","properties":{"resource":{"type":"string","description":"the resource to authorize","minLength":1},"verb":{"type":"string","description":"the operation/verb to authorize","minLength":1},"description":{"type":"string","description":"description of permission","readOnly":true},"autoAppendable":{"type":"boolean","description":"Is this a permission that is added to the admin group automatically?","readOnly":true}},"required":["resource","verb"]},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## PUT /cmn/users/{id}/authorization

> Updates the authorizations for a given user

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/{id}/authorization":{"put":{"tags":["User"],"summary":"Updates the authorizations for a given user","operationId":"writeUserPermission","parameters":[{"name":"id","in":"path","description":"User identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-user-UserPermission"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-user-UserPermissionRead"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-user-UserPermission":{"properties":{"roles":{"type":"array","description":"User roles.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"uniqueItems":true},"groups":{"type":"array","description":"User groups.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"uniqueItems":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"common-user-UserPermissionRead":{"properties":{"superUser":{"type":"boolean","default":false,"description":"is user superuser?","readOnly":true},"operations":{"type":"array","description":"list of operations","items":{"$ref":"#/components/schemas/common-user-UserPermissionRead.RolePermissionWithOrigin"},"readOnly":true}}},"common-user-UserPermissionRead.RolePermissionWithOrigin":{"description":"list of operations","properties":{"permission":{"$ref":"#/components/schemas/common-user-RolePermission"},"virtual":{"type":"boolean","default":false,"description":"virtual permission?","readOnly":true},"obtainedByRoles":{"type":"array","description":"Roles that brought this permission.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"obtainedByGroups":{"type":"array","description":"Groups that brought this permission.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true}}},"common-user-RolePermission":{"description":"the operation","properties":{"resource":{"type":"string","description":"the resource to authorize","minLength":1},"verb":{"type":"string","description":"the operation/verb to authorize","minLength":1},"description":{"type":"string","description":"description of permission","readOnly":true},"autoAppendable":{"type":"boolean","description":"Is this a permission that is added to the admin group automatically?","readOnly":true}},"required":["resource","verb"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Search dialogs to use.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Search dialogs to use.","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Key for the search dialog result.","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}}}}}
```

## PUT /cmn/users/{id}/activate

> Activate an existing resource

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/{id}/activate":{"put":{"tags":["User"],"summary":"Activate an existing resource","operationId":"activate_59","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-user-User"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-user-User":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"Is the user active?","readOnly":true},"username":{"type":"string","description":"username"},"firstName":{"type":"string","description":"first-name"},"lastName":{"type":"string","description":"last-name"},"emailAddress":{"type":"string","description":"email-address"},"owner":{"type":"boolean","default":false,"description":"Is owner user?","readOnly":true},"emailVerified":{"type":"boolean","default":false,"description":"is the email verified","readOnly":true},"validTo":{"type":"string","format":"date-time","description":"Valid to"},"type":{"type":"string","description":"User type","enum":["REGULAR","SUPPORT","SYSTEM","LIMITED_WMS","LIMITED_POS","LIMITED_DASHBOARD","LIMITED_AGENT","APP_BUILTIN_USER"]},"roles":{"type":"array","description":"Roles.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"groups":{"type":"array","description":"Groups.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"appIdentifier":{"type":"string","format":"uuid","description":"App-Identifier","readOnly":true},"referencedCustomerUserId":{"type":"integer","format":"int64","description":"Referenced customer user identifier (CustomerUserEntity.id from vab-manager).","readOnly":true}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Search dialogs to use.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Search dialogs to use.","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Key for the search dialog result.","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}}}}}
```

## GET /cmn/users/me/favorites/subscription/{subscriptionId}

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/me/favorites/subscription/{subscriptionId}":{"get":{"tags":["User"],"operationId":"getMeSubscriptionFavorite","parameters":[{"name":"subscriptionId","in":"path","description":"Output subscription identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-user-UserSubscriptionFavorite"}}}}}}}},"components":{"schemas":{"common-user-UserSubscriptionFavorite":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"refKey":{"type":"string","description":"Data type."},"eventTypes":{"type":"array","description":"Event-Types","items":{"type":"string","description":"Event-Types"}}},"required":["eventTypes","refKey"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## PUT /cmn/users/me/favorites/subscription/{subscriptionId}

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/me/favorites/subscription/{subscriptionId}":{"put":{"tags":["User"],"operationId":"updateMeSubscriptionFavorite","parameters":[{"name":"subscriptionId","in":"path","description":"Output subscription identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-user-UserSubscriptionFavorite"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-user-UserSubscriptionFavorite"}}}}}}}},"components":{"schemas":{"common-user-UserSubscriptionFavorite":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"refKey":{"type":"string","description":"Data type."},"eventTypes":{"type":"array","description":"Event-Types","items":{"type":"string","description":"Event-Types"}}},"required":["eventTypes","refKey"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## DELETE /cmn/users/me/favorites/subscription/{subscriptionId}

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/me/favorites/subscription/{subscriptionId}":{"delete":{"tags":["User"],"operationId":"deleteMeSubscriptionFavorite","parameters":[{"name":"subscriptionId","in":"path","description":"Output subscription identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}}}}
```

## GET /cmn/users/me/favorites/outputs/{favoriteId}

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/me/favorites/outputs/{favoriteId}":{"get":{"tags":["User"],"operationId":"getOutputFavoriteMe","parameters":[{"name":"favoriteId","in":"path","description":"Output favorite identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-user-UserOutputFavorite"}}}}}}}},"components":{"schemas":{"common-user-UserOutputFavorite":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"moduleRef":{"$ref":"#/components/schemas/common-output-OutputModuleRef"},"outputModuleRule":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"sourceOutputTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetOutputTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetReportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetOutputConsumerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"outputQuantity":{"type":"integer","format":"int32","description":"Number of outputs.","minimum":1},"targetOutputConsumerResult":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["moduleRef","userRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"common-output-OutputModuleRef":{"description":"print module key","properties":{"key":{"type":"string","description":"output module key"},"label":{"type":"string","description":"output module label"}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}}}}}
```

## PUT /cmn/users/me/favorites/outputs/{favoriteId}

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/me/favorites/outputs/{favoriteId}":{"put":{"tags":["User"],"operationId":"updateOutputFavoriteMe","parameters":[{"name":"favoriteId","in":"path","description":"Output favorite identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-user-UserOutputFavorite"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-user-UserOutputFavorite"}}}}}}}},"components":{"schemas":{"common-user-UserOutputFavorite":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"moduleRef":{"$ref":"#/components/schemas/common-output-OutputModuleRef"},"outputModuleRule":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"sourceOutputTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetOutputTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetReportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetOutputConsumerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"outputQuantity":{"type":"integer","format":"int32","description":"Number of outputs.","minimum":1},"targetOutputConsumerResult":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["moduleRef","userRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"common-output-OutputModuleRef":{"description":"print module key","properties":{"key":{"type":"string","description":"output module key"},"label":{"type":"string","description":"output module label"}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}}}}}
```

## DELETE /cmn/users/me/favorites/outputs/{favoriteId}

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/me/favorites/outputs/{favoriteId}":{"delete":{"tags":["User"],"operationId":"deleteOutputFavoriteMe","parameters":[{"name":"favoriteId","in":"path","description":"Output favorite identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}}}}
```

## POST /cmn/users/{id}/signature

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/{id}/signature":{"post":{"tags":["User"],"operationId":"createSignature","parameters":[{"name":"id","in":"path","description":"User identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputSignature"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-output-OutputSignature"}}}}}}}},"components":{"schemas":{"common-output-OutputSignature":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"contentType":{"type":"string","description":"ContentType","enum":["TEXT","HTML"]},"content":{"type":"string","description":"Content"}},"required":["contentType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## POST /cmn/users/{id}/favorites/subscription

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/{id}/favorites/subscription":{"post":{"tags":["User"],"operationId":"createSubscriptionFavorite","parameters":[{"name":"id","in":"path","description":"User identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-user-UserSubscriptionFavorite"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-user-UserSubscriptionFavorite"}}}}}}}},"components":{"schemas":{"common-user-UserSubscriptionFavorite":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"refKey":{"type":"string","description":"Data type."},"eventTypes":{"type":"array","description":"Event-Types","items":{"type":"string","description":"Event-Types"}}},"required":["eventTypes","refKey"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## POST /cmn/users/{id}/favorites/outputs

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/{id}/favorites/outputs":{"post":{"tags":["User"],"operationId":"createOutputFavorite","parameters":[{"name":"id","in":"path","description":"User identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-user-UserOutputFavorite"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-user-UserOutputFavorite"}}}}}}}},"components":{"schemas":{"common-user-UserOutputFavorite":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"moduleRef":{"$ref":"#/components/schemas/common-output-OutputModuleRef"},"outputModuleRule":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"sourceOutputTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetOutputTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetReportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetOutputConsumerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"outputQuantity":{"type":"integer","format":"int32","description":"Number of outputs.","minimum":1},"targetOutputConsumerResult":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["moduleRef","userRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"common-output-OutputModuleRef":{"description":"print module key","properties":{"key":{"type":"string","description":"output module key"},"label":{"type":"string","description":"output module label"}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}}}}}
```

## GET /cmn/users/me/settings/{settingKey}

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/me/settings/{settingKey}":{"get":{"tags":["User"],"operationId":"singleSetting","parameters":[{"name":"settingKey","in":"path","description":"setting key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-user-UserSetting"}}}}}}}},"components":{"schemas":{"common-user-UserSetting":{"properties":{"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"key":{"type":"string","description":"setting-key"},"value":{"type":"string","description":"setting-value"}},"required":["key","value"]},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## POST /cmn/users/me/settings/{settingKey}

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/me/settings/{settingKey}":{"post":{"tags":["User"],"operationId":"storeUserSetting","parameters":[{"name":"settingKey","in":"path","description":"setting key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-user-UserSetting"}}}}}}}},"components":{"schemas":{"common-user-UserSetting":{"properties":{"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"key":{"type":"string","description":"setting-key"},"value":{"type":"string","description":"setting-value"}},"required":["key","value"]},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## DELETE /cmn/users/me/settings/{settingKey}

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/me/settings/{settingKey}":{"delete":{"tags":["User"],"operationId":"deleteSingleSetting","parameters":[{"name":"settingKey","in":"path","description":"setting key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}}}}
```

## POST /cmn/users/me/favorites/subscription

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/me/favorites/subscription":{"post":{"tags":["User"],"operationId":"createMeSubscriptionFavorite","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-user-UserSubscriptionFavorite"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-user-UserSubscriptionFavorite"}}}}}}}},"components":{"schemas":{"common-user-UserSubscriptionFavorite":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"refKey":{"type":"string","description":"Data type."},"eventTypes":{"type":"array","description":"Event-Types","items":{"type":"string","description":"Event-Types"}}},"required":["eventTypes","refKey"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## POST /cmn/users/me/favorites/outputs

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/me/favorites/outputs":{"post":{"tags":["User"],"operationId":"createOutputFavoriteMe","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-user-UserOutputFavorite"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-user-UserOutputFavorite"}}}}}}}},"components":{"schemas":{"common-user-UserOutputFavorite":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"moduleRef":{"$ref":"#/components/schemas/common-output-OutputModuleRef"},"outputModuleRule":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"sourceOutputTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetOutputTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetReportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetOutputConsumerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"outputQuantity":{"type":"integer","format":"int32","description":"Number of outputs.","minimum":1},"targetOutputConsumerResult":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["moduleRef","userRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"common-output-OutputModuleRef":{"description":"print module key","properties":{"key":{"type":"string","description":"output module key"},"label":{"type":"string","description":"output module label"}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}}}}}
```

## GET /cmn/users

> Provides all Users (without hidden buildin users)

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users":{"get":{"tags":["User"],"summary":"Provides all Users (without hidden buildin users)","operationId":"getUsers","responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/common-user-User"}}}}}}}}},"components":{"schemas":{"common-user-User":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"Is the user active?","readOnly":true},"username":{"type":"string","description":"username"},"firstName":{"type":"string","description":"first-name"},"lastName":{"type":"string","description":"last-name"},"emailAddress":{"type":"string","description":"email-address"},"owner":{"type":"boolean","default":false,"description":"Is owner user?","readOnly":true},"emailVerified":{"type":"boolean","default":false,"description":"is the email verified","readOnly":true},"validTo":{"type":"string","format":"date-time","description":"Valid to"},"type":{"type":"string","description":"User type","enum":["REGULAR","SUPPORT","SYSTEM","LIMITED_WMS","LIMITED_POS","LIMITED_DASHBOARD","LIMITED_AGENT","APP_BUILTIN_USER"]},"roles":{"type":"array","description":"Roles.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"groups":{"type":"array","description":"Groups.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"appIdentifier":{"type":"string","format":"uuid","description":"App-Identifier","readOnly":true},"referencedCustomerUserId":{"type":"integer","format":"int64","description":"Referenced customer user identifier (CustomerUserEntity.id from vab-manager).","readOnly":true}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## GET /cmn/users/{id}/available-permissions

> Provides all roles defined in the system that are feasible for the given user

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/{id}/available-permissions":{"get":{"tags":["User"],"summary":"Provides all roles defined in the system that are feasible for the given user","operationId":"availablePermission","parameters":[{"name":"id","in":"path","description":"User identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/common-user-RolePermission"}}}}}}}}},"components":{"schemas":{"common-user-RolePermission":{"description":"the operation","properties":{"resource":{"type":"string","description":"the resource to authorize","minLength":1},"verb":{"type":"string","description":"the operation/verb to authorize","minLength":1},"description":{"type":"string","description":"description of permission","readOnly":true},"autoAppendable":{"type":"boolean","description":"Is this a permission that is added to the admin group automatically?","readOnly":true}},"required":["resource","verb"]}}}}
```

## GET /cmn/users/me

> Provides the current user

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/me":{"get":{"tags":["User"],"summary":"Provides the current user","operationId":"getMe","responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-user-MeResponse"}}}}}}}},"components":{"schemas":{"common-user-MeResponse":{"properties":{"user":{"$ref":"#/components/schemas/common-user-User"},"company":{"$ref":"#/components/schemas/common-user-MyCompany"},"tenantId":{"type":"integer","format":"int64","description":"Current tenant identifier.","readOnly":true},"managedByPartner":{"type":"boolean","description":"Whether this tenant's customer is looked after by a partner.","readOnly":true}}},"common-user-User":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"Is the user active?","readOnly":true},"username":{"type":"string","description":"username"},"firstName":{"type":"string","description":"first-name"},"lastName":{"type":"string","description":"last-name"},"emailAddress":{"type":"string","description":"email-address"},"owner":{"type":"boolean","default":false,"description":"Is owner user?","readOnly":true},"emailVerified":{"type":"boolean","default":false,"description":"is the email verified","readOnly":true},"validTo":{"type":"string","format":"date-time","description":"Valid to"},"type":{"type":"string","description":"User type","enum":["REGULAR","SUPPORT","SYSTEM","LIMITED_WMS","LIMITED_POS","LIMITED_DASHBOARD","LIMITED_AGENT","APP_BUILTIN_USER"]},"roles":{"type":"array","description":"Roles.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"groups":{"type":"array","description":"Groups.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"appIdentifier":{"type":"string","format":"uuid","description":"App-Identifier","readOnly":true},"referencedCustomerUserId":{"type":"integer","format":"int64","description":"Referenced customer user identifier (CustomerUserEntity.id from vab-manager).","readOnly":true}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"common-user-MyCompany":{"description":"My address.","properties":{"id":{"type":"string","description":"Unique identifier of the Object"},"name1":{"type":"string","description":"Name."},"name2":{"type":"string","description":"Name2"},"name3":{"type":"string","description":"Name3"},"street":{"type":"string","description":"Street."},"streetAddressNumber":{"type":"string","description":"Street address number."},"city":{"type":"string","description":"City."},"postalCode":{"type":"string","description":"Postal code."},"languageCodeIso2a":{"type":"string","description":"Language code ISO Alpha-2."},"languageCodeId":{"type":"integer","format":"int64","description":"Language code identifier."},"countryCodeIso2a":{"type":"string","description":"Country code ISO Alpha-2."},"countryCodeId":{"type":"integer","format":"int64","description":"Country identifier."},"currencyCodeIso3a":{"type":"string","description":"Currency code ISO Alpha-3."},"currencyCodeId":{"type":"integer","format":"int64","description":"Currency identifier."},"createdAt":{"type":"string","format":"date-time","description":"Creation time."}}}}}}
```

## GET /cmn/users/me/settings

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/me/settings":{"get":{"tags":["User"],"operationId":"allSettings","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/common-user-UserSetting"}}}}}}}}},"components":{"schemas":{"common-user-UserSetting":{"properties":{"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"key":{"type":"string","description":"setting-key"},"value":{"type":"string","description":"setting-value"}},"required":["key","value"]},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## GET /cmn/users/me/authorization

> Provides the authorizations for the current user

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/me/authorization":{"get":{"tags":["User"],"summary":"Provides the authorizations for the current user","operationId":"getMyAuthorizations","responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-user-UserPermissionRead"}}}}}}}},"components":{"schemas":{"common-user-UserPermissionRead":{"properties":{"superUser":{"type":"boolean","default":false,"description":"is user superuser?","readOnly":true},"operations":{"type":"array","description":"list of operations","items":{"$ref":"#/components/schemas/common-user-UserPermissionRead.RolePermissionWithOrigin"},"readOnly":true}}},"common-user-UserPermissionRead.RolePermissionWithOrigin":{"description":"list of operations","properties":{"permission":{"$ref":"#/components/schemas/common-user-RolePermission"},"virtual":{"type":"boolean","default":false,"description":"virtual permission?","readOnly":true},"obtainedByRoles":{"type":"array","description":"Roles that brought this permission.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"obtainedByGroups":{"type":"array","description":"Groups that brought this permission.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true}}},"common-user-RolePermission":{"description":"the operation","properties":{"resource":{"type":"string","description":"the resource to authorize","minLength":1},"verb":{"type":"string","description":"the operation/verb to authorize","minLength":1},"description":{"type":"string","description":"description of permission","readOnly":true},"autoAppendable":{"type":"boolean","description":"Is this a permission that is added to the admin group automatically?","readOnly":true}},"required":["resource","verb"]},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## GET /cmn/users/me/authorization/{resource}

> Provides the authorizations of a given resource for the current user

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/me/authorization/{resource}":{"get":{"tags":["User"],"summary":"Provides the authorizations of a given resource for the current user","operationId":"getMyAppPermissions","parameters":[{"name":"resource","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/common-user-RolePermission"}}}}}}}}},"components":{"schemas":{"common-user-RolePermission":{"description":"the operation","properties":{"resource":{"type":"string","description":"the resource to authorize","minLength":1},"verb":{"type":"string","description":"the operation/verb to authorize","minLength":1},"description":{"type":"string","description":"description of permission","readOnly":true},"autoAppendable":{"type":"boolean","description":"Is this a permission that is added to the admin group automatically?","readOnly":true}},"required":["resource","verb"]}}}}
```

## GET /cmn/users/all

> Provides all Users (without hidden buildin users)

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"User","description":"User."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/users/all":{"get":{"tags":["User"],"summary":"Provides all Users (without hidden buildin users)","operationId":"getAllUsers","responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}}}}}}}},"components":{"schemas":{"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developer.vario-software.de/api-reference/user.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
