Role

Benutzerrollen

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

404

Resource with given ID was not found

application/json

get

/cmn/users/roles/{id}

HTTPcURLJavaScriptPython

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

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:09:41.663Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:09:41.663Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "active": true,
  "label": "text",
  "description": "text",
  "permissions": [
    {
      "resource": "text",
      "verb": "text",
      "description": "text",
      "autoAppendable": true
    }
  ],
  "dmsAccessLevelRead": 1,
  "dmsAccessLevelWrite": 1,
  "dmsAccessLevelDelete": 1,
  "systemPresetting": true
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

activebooleanRead-onlyOptional

Is the role active?

Default: true

labelstringRequired

Bezeichnung

descriptionstringOptional

Beschreibung

dmsAccessLevelReadinteger · int32Optional

access level or reading

dmsAccessLevelWriteinteger · int32Optional

access level for writing

dmsAccessLevelDeleteinteger · int32Optional

access level for deleting

systemPresettingbooleanRead-onlyOptional

system presetting

Responses

200

successful operation

application/json

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put

/cmn/users/roles/{id}

HTTPcURLJavaScriptPython

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

{
  "version": "text",
  "info": {},
  "id": "text",
  "label": "text",
  "description": "text",
  "permissions": [
    {
      "resource": "text",
      "verb": "text"
    }
  ],
  "dmsAccessLevelRead": 1,
  "dmsAccessLevelWrite": 1,
  "dmsAccessLevelDelete": 1
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:09:41.663Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:09:41.663Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "active": true,
  "label": "text",
  "description": "text",
  "permissions": [
    {
      "resource": "text",
      "verb": "text",
      "description": "text",
      "autoAppendable": true
    }
  ],
  "dmsAccessLevelRead": 1,
  "dmsAccessLevelWrite": 1,
  "dmsAccessLevelDelete": 1,
  "systemPresetting": true
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

404

Resource was not found

application/json

409

unable to delete Resource, due to constraints, existing references or internal state

application/json

delete

/cmn/users/roles/{id}

HTTPcURLJavaScriptPython

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

{
  "context": "text",
  "messageValue": "text"
}

deaktiviert eine bestehende Resource

put

Path parameters

idinteger · int64Required

identifier

Responses

200

successful operation

application/json

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put

/cmn/users/roles/{id}/deactivate

HTTPcURLJavaScriptPython

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

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:09:41.663Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:09:41.663Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "active": true,
  "label": "text",
  "description": "text",
  "permissions": [
    {
      "resource": "text",
      "verb": "text",
      "description": "text",
      "autoAppendable": true
    }
  ],
  "dmsAccessLevelRead": 1,
  "dmsAccessLevelWrite": 1,
  "dmsAccessLevelDelete": 1,
  "systemPresetting": true
}

aktiviert eine bestehende Resource

put

Path parameters

idinteger · int64Required

identifier

Responses

200

successful operation

application/json

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put

/cmn/users/roles/{id}/activate

HTTPcURLJavaScriptPython

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

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:09:41.663Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:09:41.663Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "active": true,
  "label": "text",
  "description": "text",
  "permissions": [
    {
      "resource": "text",
      "verb": "text",
      "description": "text",
      "autoAppendable": true
    }
  ],
  "dmsAccessLevelRead": 1,
  "dmsAccessLevelWrite": 1,
  "dmsAccessLevelDelete": 1,
  "systemPresetting": true
}

Create new Resource

post

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

activebooleanRead-onlyOptional

Is the role active?

Default: true

labelstringRequired

Bezeichnung

descriptionstringOptional

Beschreibung

dmsAccessLevelReadinteger · int32Optional

access level or reading

dmsAccessLevelWriteinteger · int32Optional

access level for writing

dmsAccessLevelDeleteinteger · int32Optional

access level for deleting

systemPresettingbooleanRead-onlyOptional

system presetting

Responses

200

successful operation

application/json

422

Resource was not valid to process

application/json

post

/cmn/users/roles

HTTPcURLJavaScriptPython

POST /api/cmn/users/roles HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 198

{
  "version": "text",
  "info": {},
  "id": "text",
  "label": "text",
  "description": "text",
  "permissions": [
    {
      "resource": "text",
      "verb": "text"
    }
  ],
  "dmsAccessLevelRead": 1,
  "dmsAccessLevelWrite": 1,
  "dmsAccessLevelDelete": 1
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:09:41.663Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:09:41.663Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "active": true,
  "label": "text",
  "description": "text",
  "permissions": [
    {
      "resource": "text",
      "verb": "text",
      "description": "text",
      "autoAppendable": true
    }
  ],
  "dmsAccessLevelRead": 1,
  "dmsAccessLevelWrite": 1,
  "dmsAccessLevelDelete": 1,
  "systemPresetting": true
}

Provides all roles defined in the system

get

Responses

200

successful operation

application/json

get

/cmn/users/roles/permissions

HTTPcURLJavaScriptPython

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

200

successful operation

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