Role

Benutzerrollen

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

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

404

Resource with given ID was not found

application/json

get/cmn/users/roles/{id}

GET /api/cmn/users/roles/{id} HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T00:53:51.653Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T00:53:51.653Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "active": true,
  "label": "text",
  "description": "text",
  "permissions": [],
  "dmsAccessLevelRead": 1,
  "dmsAccessLevelWrite": 1,
  "dmsAccessLevelDelete": 1,
  "systemPresetting": true
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

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

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

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put/cmn/users/roles/{id}

PUT /api/cmn/users/roles/{id} HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 165

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

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T00:53:51.653Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T00:53:51.653Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "active": true,
  "label": "text",
  "description": "text",
  "permissions": [],
  "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

contextstringOptional

message context

messageValuestringOptional

message

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}

DELETE /api/cmn/users/roles/{id} HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

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

deaktiviert eine bestehende Resource

put

Path parameters

idinteger · int64Required

identifier

Responses

200

successful operation

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

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

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

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

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T00:53:51.653Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T00:53:51.653Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "active": true,
  "label": "text",
  "description": "text",
  "permissions": [],
  "dmsAccessLevelRead": 1,
  "dmsAccessLevelWrite": 1,
  "dmsAccessLevelDelete": 1,
  "systemPresetting": true
}

aktiviert eine bestehende Resource

put

Path parameters

idinteger · int64Required

identifier

Responses

200

successful operation

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

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

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

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

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T00:53:51.653Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T00:53:51.653Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "active": true,
  "label": "text",
  "description": "text",
  "permissions": [],
  "dmsAccessLevelRead": 1,
  "dmsAccessLevelWrite": 1,
  "dmsAccessLevelDelete": 1,
  "systemPresetting": true
}

Create new Resource

post

Body

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

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

422

Resource was not valid to process

application/json

post/cmn/users/roles

POST /api/cmn/users/roles HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 165

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

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T00:53:51.653Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T00:53:51.653Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "active": true,
  "label": "text",
  "description": "text",
  "permissions": [],
  "dmsAccessLevelRead": 1,
  "dmsAccessLevelWrite": 1,
  "dmsAccessLevelDelete": 1,
  "systemPresetting": true
}

Provides all roles defined in the system

get

Responses

200

successful operation

application/json

the operation

resourcestringRequired

the resource to authorize

verbstringRequired

the operation/verb to authorize

descriptionstringRead-onlyOptional

description of permission

autoAppendablebooleanRead-onlyOptional

ist diese Berechtigung eine, die der Admin-Gruppe automatisch hinzugefügt wird

get/cmn/users/roles/permissions

GET /api/cmn/users/roles/permissions HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

successful operation

[]

PreviousOutput Consumer NextContact Type

Last updated 11 hours ago

Was this helpful?