User

Benutzer

get

Path parameters

idinteger · int64Required

user id

signatureIdinteger · int64Required

Signature id

Responses

200

OK

*/*

get

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

HTTPcURLJavaScriptPython

GET /api/cmn/users/{id}/signature/{signatureId} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:54:56.533Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:54:56.533Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "userRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "contentType": "TEXT",
  "content": "text"
}

put

Path parameters

idinteger · int64Required

user id

signatureIdinteger · int64Required

Signature id

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

contentTypestring · enumRequired

ContentType

Possible values:

contentstringOptional

Content

Responses

200

OK

*/*

put

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

HTTPcURLJavaScriptPython

PUT /api/cmn/users/{id}/signature/{signatureId} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "version": "text",
  "info": {},
  "id": "text",
  "userRef": {
    "id": "text"
  },
  "contentType": "TEXT",
  "content": "text"
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:54:56.533Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:54:56.533Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "userRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "contentType": "TEXT",
  "content": "text"
}

delete

Path parameters

idinteger · int64Required

user id

signatureIdinteger · int64Required

Signature id

Responses

200

OK

No content

delete

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

HTTPcURLJavaScriptPython

DELETE /api/cmn/users/{id}/signature/{signatureId} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

No content

get

Path parameters

idinteger · int64Required

user id

subscriptionIdinteger · int64Required

Output Favorite id

Responses

200

OK

*/*

get

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

HTTPcURLJavaScriptPython

GET /api/cmn/users/{id}/favorites/subscription/{subscriptionId} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:54:56.533Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:54:56.533Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "userRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "refKey": "text",
  "eventTypes": [
    "text"
  ]
}

put

Path parameters

idinteger · int64Required

user id

subscriptionIdinteger · int64Required

Output Favorite id

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

refKeystringRequired

Datentyp

eventTypesstring[]Required

Event-Types

Responses

200

OK

*/*

put

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

HTTPcURLJavaScriptPython

PUT /api/cmn/users/{id}/favorites/subscription/{subscriptionId} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "version": "text",
  "info": {},
  "id": "text",
  "userRef": {
    "id": "text"
  },
  "refKey": "text",
  "eventTypes": [
    "text"
  ]
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:54:56.533Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:54:56.533Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "userRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "refKey": "text",
  "eventTypes": [
    "text"
  ]
}

delete

Path parameters

idinteger · int64Required

user id

subscriptionIdinteger · int64Required

Output Favorite id

Responses

200

OK

No content

delete

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

HTTPcURLJavaScriptPython

DELETE /api/cmn/users/{id}/favorites/subscription/{subscriptionId} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

No content

get

Path parameters

idinteger · int64Required

user id

favoriteIdinteger · int64Required

Output Favorite id

Responses

200

OK

*/*

get

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

HTTPcURLJavaScriptPython

GET /api/cmn/users/{id}/favorites/outputs/{favoriteId} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:54:56.533Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:54:56.533Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "userRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "moduleRef": {
    "key": "text",
    "label": "text"
  },
  "outputModuleRule": {},
  "sourceOutputTypeRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputTypeRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetReportGroupRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputConsumerRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputConsumerResult": {}
}

put

Path parameters

idinteger · int64Required

user id

favoriteIdinteger · int64Required

Output Favorite id

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

outputModuleRuleobjectOptional

Search-Dialog

targetOutputConsumerResultobjectOptional

Search-Dialog

Responses

200

OK

*/*

put

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

HTTPcURLJavaScriptPython

PUT /api/cmn/users/{id}/favorites/outputs/{favoriteId} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 309

{
  "version": "text",
  "info": {},
  "id": "text",
  "userRef": {
    "id": "text"
  },
  "moduleRef": {
    "key": "text",
    "label": "text"
  },
  "outputModuleRule": {},
  "sourceOutputTypeRef": {
    "id": "text"
  },
  "targetOutputTypeRef": {
    "id": "text"
  },
  "targetReportGroupRef": {
    "id": "text"
  },
  "targetOutputConsumerRef": {
    "id": "text"
  },
  "targetOutputConsumerResult": {}
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:54:56.533Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:54:56.533Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "userRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "moduleRef": {
    "key": "text",
    "label": "text"
  },
  "outputModuleRule": {},
  "sourceOutputTypeRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputTypeRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetReportGroupRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputConsumerRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputConsumerResult": {}
}

delete

Path parameters

idinteger · int64Required

user id

favoriteIdinteger · int64Required

Output Favorite id

Responses

200

OK

No content

delete

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

HTTPcURLJavaScriptPython

DELETE /api/cmn/users/{id}/favorites/outputs/{favoriteId} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

No content

deaktiviert eine bestehende Resource

put

Path parameters

idinteger · int64Required

identifier

Responses

200

successful operation

*/*

404

Resource was not found

*/*

422

Resource was not valid to process

*/*

put

/cmn/users/{id}/deactivate

HTTPcURLJavaScriptPython

PUT /api/cmn/users/{id}/deactivate HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:54:56.533Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:54:56.533Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "active": true,
  "username": "text",
  "firstName": "text",
  "lastName": "text",
  "emailAddress": "text",
  "owner": false,
  "emailVerified": false,
  "validTo": "2026-02-10T16:54:56.533Z",
  "type": "REGULAR",
  "roles": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ],
  "groups": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ],
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

Provides the authorizations for a given user

get

Path parameters

idinteger · int64Required

user id

Responses

200

successful operation

*/*

get

/cmn/users/{id}/authorization

HTTPcURLJavaScriptPython

GET /api/cmn/users/{id}/authorization HTTP/1.1
Host: localhost:53907
Accept: */*

200

successful operation

{
  "superUser": false,
  "operations": [
    {
      "permission": {
        "resource": "text",
        "verb": "text",
        "description": "text",
        "autoAppendable": true
      },
      "virtual": false,
      "obtainedByRoles": [
        {
          "id": "text",
          "label": "text",
          "description": "text",
          "active": true
        }
      ],
      "obtainedByGroups": [
        {
          "id": "text",
          "label": "text",
          "description": "text",
          "active": true
        }
      ]
    }
  ]
}

Updates the authorizations for a given user

put

Path parameters

idinteger · int64Required

user id

Body

application/json

Responses

200

successful operation

*/*

422

Resource was not valid to process

*/*

put

/cmn/users/{id}/authorization

HTTPcURLJavaScriptPython

PUT /api/cmn/users/{id}/authorization HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "roles": [
    {
      "id": "text"
    }
  ],
  "groups": [
    {
      "id": "text"
    }
  ]
}

{
  "superUser": false,
  "operations": [
    {
      "permission": {
        "resource": "text",
        "verb": "text",
        "description": "text",
        "autoAppendable": true
      },
      "virtual": false,
      "obtainedByRoles": [
        {
          "id": "text",
          "label": "text",
          "description": "text",
          "active": true
        }
      ],
      "obtainedByGroups": [
        {
          "id": "text",
          "label": "text",
          "description": "text",
          "active": true
        }
      ]
    }
  ]
}

aktiviert eine bestehende Resource

put

Path parameters

idinteger · int64Required

identifier

Responses

200

successful operation

*/*

404

Resource was not found

*/*

422

Resource was not valid to process

*/*

put

/cmn/users/{id}/activate

HTTPcURLJavaScriptPython

PUT /api/cmn/users/{id}/activate HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:54:56.533Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:54:56.533Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "active": true,
  "username": "text",
  "firstName": "text",
  "lastName": "text",
  "emailAddress": "text",
  "owner": false,
  "emailVerified": false,
  "validTo": "2026-02-10T16:54:56.533Z",
  "type": "REGULAR",
  "roles": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ],
  "groups": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ],
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

get

Path parameters

subscriptionIdinteger · int64Required

Output Subscription id

Responses

200

OK

*/*

get

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

HTTPcURLJavaScriptPython

GET /api/cmn/users/me/favorites/subscription/{subscriptionId} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:54:56.533Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:54:56.533Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "userRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "refKey": "text",
  "eventTypes": [
    "text"
  ]
}

put

Path parameters

subscriptionIdinteger · int64Required

Output Subscription id

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

refKeystringRequired

Datentyp

eventTypesstring[]Required

Event-Types

Responses

200

OK

*/*

put

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

HTTPcURLJavaScriptPython

PUT /api/cmn/users/me/favorites/subscription/{subscriptionId} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "version": "text",
  "info": {},
  "id": "text",
  "userRef": {
    "id": "text"
  },
  "refKey": "text",
  "eventTypes": [
    "text"
  ]
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:54:56.533Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:54:56.533Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "userRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "refKey": "text",
  "eventTypes": [
    "text"
  ]
}

delete

Path parameters

subscriptionIdinteger · int64Required

Output Subscription id

Responses

200

OK

No content

delete

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

HTTPcURLJavaScriptPython

DELETE /api/cmn/users/me/favorites/subscription/{subscriptionId} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

No content

get

Path parameters

favoriteIdinteger · int64Required

Output Favorite id

Responses

200

OK

*/*

get

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

HTTPcURLJavaScriptPython

GET /api/cmn/users/me/favorites/outputs/{favoriteId} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:54:56.533Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:54:56.533Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "userRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "moduleRef": {
    "key": "text",
    "label": "text"
  },
  "outputModuleRule": {},
  "sourceOutputTypeRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputTypeRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetReportGroupRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputConsumerRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputConsumerResult": {}
}

put

Path parameters

favoriteIdinteger · int64Required

Output Favorite id

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

outputModuleRuleobjectOptional

Search-Dialog

targetOutputConsumerResultobjectOptional

Search-Dialog

Responses

200

OK

*/*

put

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

HTTPcURLJavaScriptPython

PUT /api/cmn/users/me/favorites/outputs/{favoriteId} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 309

{
  "version": "text",
  "info": {},
  "id": "text",
  "userRef": {
    "id": "text"
  },
  "moduleRef": {
    "key": "text",
    "label": "text"
  },
  "outputModuleRule": {},
  "sourceOutputTypeRef": {
    "id": "text"
  },
  "targetOutputTypeRef": {
    "id": "text"
  },
  "targetReportGroupRef": {
    "id": "text"
  },
  "targetOutputConsumerRef": {
    "id": "text"
  },
  "targetOutputConsumerResult": {}
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:54:56.533Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:54:56.533Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "userRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "moduleRef": {
    "key": "text",
    "label": "text"
  },
  "outputModuleRule": {},
  "sourceOutputTypeRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputTypeRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetReportGroupRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputConsumerRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputConsumerResult": {}
}

delete

Path parameters

favoriteIdinteger · int64Required

Output Favorite id

Responses

200

OK

No content

delete

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

HTTPcURLJavaScriptPython

DELETE /api/cmn/users/me/favorites/outputs/{favoriteId} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

No content

post

Path parameters

idinteger · int64Required

user id

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

contentTypestring · enumRequired

ContentType

Possible values:

contentstringOptional

Content

Responses

200

OK

*/*

post

/cmn/users/{id}/signature

HTTPcURLJavaScriptPython

POST /api/cmn/users/{id}/signature HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "version": "text",
  "info": {},
  "id": "text",
  "userRef": {
    "id": "text"
  },
  "contentType": "TEXT",
  "content": "text"
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:54:56.533Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:54:56.533Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "userRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "contentType": "TEXT",
  "content": "text"
}

post

Path parameters

idinteger · int64Required

user id

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

refKeystringRequired

Datentyp

eventTypesstring[]Required

Event-Types

Responses

200

OK

*/*

post

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

HTTPcURLJavaScriptPython

POST /api/cmn/users/{id}/favorites/subscription HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "version": "text",
  "info": {},
  "id": "text",
  "userRef": {
    "id": "text"
  },
  "refKey": "text",
  "eventTypes": [
    "text"
  ]
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:54:56.533Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:54:56.533Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "userRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "refKey": "text",
  "eventTypes": [
    "text"
  ]
}

post

Path parameters

idinteger · int64Required

user id

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

outputModuleRuleobjectOptional

Search-Dialog

targetOutputConsumerResultobjectOptional

Search-Dialog

Responses

200

OK

*/*

post

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

HTTPcURLJavaScriptPython

POST /api/cmn/users/{id}/favorites/outputs HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 309

{
  "version": "text",
  "info": {},
  "id": "text",
  "userRef": {
    "id": "text"
  },
  "moduleRef": {
    "key": "text",
    "label": "text"
  },
  "outputModuleRule": {},
  "sourceOutputTypeRef": {
    "id": "text"
  },
  "targetOutputTypeRef": {
    "id": "text"
  },
  "targetReportGroupRef": {
    "id": "text"
  },
  "targetOutputConsumerRef": {
    "id": "text"
  },
  "targetOutputConsumerResult": {}
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:54:56.533Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:54:56.533Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "userRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "moduleRef": {
    "key": "text",
    "label": "text"
  },
  "outputModuleRule": {},
  "sourceOutputTypeRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputTypeRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetReportGroupRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputConsumerRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputConsumerResult": {}
}

get

Path parameters

settingKeystringRequired

setting key

Responses

200

OK

*/*

get

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

HTTPcURLJavaScriptPython

GET /api/cmn/users/me/settings/{settingKey} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "userRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "key": "text",
  "value": "text"
}

post

Path parameters

settingKeystringRequired

setting key

Body

application/json

stringOptional

Responses

200

OK

*/*

post

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

HTTPcURLJavaScriptPython

POST /api/cmn/users/me/settings/{settingKey} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

200

OK

{
  "userRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "key": "text",
  "value": "text"
}

delete

Path parameters

settingKeystringRequired

setting key

Responses

200

OK

No content

delete

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

HTTPcURLJavaScriptPython

DELETE /api/cmn/users/me/settings/{settingKey} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

No content

post

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

refKeystringRequired

Datentyp

eventTypesstring[]Required

Event-Types

Responses

200

OK

*/*

post

/cmn/users/me/favorites/subscription

HTTPcURLJavaScriptPython

POST /api/cmn/users/me/favorites/subscription HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "version": "text",
  "info": {},
  "id": "text",
  "userRef": {
    "id": "text"
  },
  "refKey": "text",
  "eventTypes": [
    "text"
  ]
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:54:56.533Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:54:56.533Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "userRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "refKey": "text",
  "eventTypes": [
    "text"
  ]
}

post

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

outputModuleRuleobjectOptional

Search-Dialog

targetOutputConsumerResultobjectOptional

Search-Dialog

Responses

200

OK

*/*

post

/cmn/users/me/favorites/outputs

HTTPcURLJavaScriptPython

POST /api/cmn/users/me/favorites/outputs HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 309

{
  "version": "text",
  "info": {},
  "id": "text",
  "userRef": {
    "id": "text"
  },
  "moduleRef": {
    "key": "text",
    "label": "text"
  },
  "outputModuleRule": {},
  "sourceOutputTypeRef": {
    "id": "text"
  },
  "targetOutputTypeRef": {
    "id": "text"
  },
  "targetReportGroupRef": {
    "id": "text"
  },
  "targetOutputConsumerRef": {
    "id": "text"
  },
  "targetOutputConsumerResult": {}
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:54:56.533Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:54:56.533Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "userRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "moduleRef": {
    "key": "text",
    "label": "text"
  },
  "outputModuleRule": {},
  "sourceOutputTypeRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputTypeRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetReportGroupRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputConsumerRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputConsumerResult": {}
}

Provides all Users (without hidden buildin users)

get

Responses

200

successful operation

*/*

get

/cmn/users

HTTPcURLJavaScriptPython

GET /api/cmn/users HTTP/1.1
Host: localhost:53907
Accept: */*

200

successful operation

[
  {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T16:54:56.533Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T16:54:56.533Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "active": true,
    "username": "text",
    "firstName": "text",
    "lastName": "text",
    "emailAddress": "text",
    "owner": false,
    "emailVerified": false,
    "validTo": "2026-02-10T16:54:56.533Z",
    "type": "REGULAR",
    "roles": [
      {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      }
    ],
    "groups": [
      {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      }
    ],
    "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

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

get

Path parameters

idinteger · int64Required

user id

Responses

200

successful operation

*/*

get

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

HTTPcURLJavaScriptPython

GET /api/cmn/users/{id}/available-permissions HTTP/1.1
Host: localhost:53907
Accept: */*

200

successful operation

[
  {
    "resource": "text",
    "verb": "text",
    "description": "text",
    "autoAppendable": true
  }
]

Provides the current user

get

Responses

200

successful operation

*/*

get

/cmn/users/me

HTTPcURLJavaScriptPython

GET /api/cmn/users/me HTTP/1.1
Host: localhost:53907
Accept: */*

200

successful operation

{
  "user": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T16:54:56.533Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T16:54:56.533Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "active": true,
    "username": "text",
    "firstName": "text",
    "lastName": "text",
    "emailAddress": "text",
    "owner": false,
    "emailVerified": false,
    "validTo": "2026-02-10T16:54:56.533Z",
    "type": "REGULAR",
    "roles": [
      {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      }
    ],
    "groups": [
      {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      }
    ],
    "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  },
  "company": {
    "id": "1",
    "name1": "text",
    "name2": "text",
    "name3": "text",
    "street": "text",
    "streetAddressNumber": "text",
    "city": "text",
    "postalCode": "text",
    "languageCodeIso2a": "text",
    "languageCodeId": 1,
    "countryCodeIso2a": "text",
    "countryCodeId": 1,
    "currencyCodeIso3a": "text",
    "currencyCodeId": 1,
    "createdAt": "2026-02-10T16:54:56.533Z"
  }
}

get

Responses

200

OK

*/*

get

/cmn/users/me/settings

HTTPcURLJavaScriptPython

GET /api/cmn/users/me/settings HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

[
  {
    "userRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "key": "text",
    "value": "text"
  }
]

Provides the authorizations for the current user

get

Responses

200

successful operation

*/*

get

/cmn/users/me/authorization

HTTPcURLJavaScriptPython

GET /api/cmn/users/me/authorization HTTP/1.1
Host: localhost:53907
Accept: */*

200

successful operation

{
  "superUser": false,
  "operations": [
    {
      "permission": {
        "resource": "text",
        "verb": "text",
        "description": "text",
        "autoAppendable": true
      },
      "virtual": false,
      "obtainedByRoles": [
        {
          "id": "text",
          "label": "text",
          "description": "text",
          "active": true
        }
      ],
      "obtainedByGroups": [
        {
          "id": "text",
          "label": "text",
          "description": "text",
          "active": true
        }
      ]
    }
  ]
}

Provides the authorizations of a given resource for the current user

get

Path parameters

resourcestringRequired

Responses

200

successful operation

*/*

get

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

HTTPcURLJavaScriptPython

GET /api/cmn/users/me/authorization/{resource} HTTP/1.1
Host: localhost:53907
Accept: */*

200

successful operation

[
  {
    "resource": "text",
    "verb": "text",
    "description": "text",
    "autoAppendable": true
  }
]

Provides all Users (without hidden buildin users)

get

Responses

200

successful operation

*/*

get

/cmn/users/all

HTTPcURLJavaScriptPython

GET /api/cmn/users/all HTTP/1.1
Host: localhost:53907
Accept: */*

200

successful operation

[
  {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  }
]