For the complete documentation index, see llms.txt. This page is also available as Markdown.

User

Benutzer

get
Path parameters
idinteger · int64Required

user id

signatureIdinteger · int64Required

Signature id

Responses
200

OK

*/*
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

contentTypestring · enumRequired

ContentType

Possible values:
contentstringOptional

Content

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

OK

put
Path parameters
idinteger · int64Required

user id

signatureIdinteger · int64Required

Signature id

Body
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

contentTypestring · enumRequired

ContentType

Possible values:
contentstringOptional

Content

Responses
200

OK

*/*
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

contentTypestring · enumRequired

ContentType

Possible values:
contentstringOptional

Content

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

OK

delete
Path parameters
idinteger · int64Required

user id

signatureIdinteger · int64Required

Signature id

Responses
200

OK

No content

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

OK

No content

get
Path parameters
idinteger · int64Required

user id

subscriptionIdinteger · int64Required

Output Favorite id

Responses
200

OK

*/*
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

refKeystringRequired

Datentyp

eventTypesstring[]Required

Event-Types

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

OK

put
Path parameters
idinteger · int64Required

user id

subscriptionIdinteger · int64Required

Output Favorite id

Body
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

refKeystringRequired

Datentyp

eventTypesstring[]Required

Event-Types

Responses
200

OK

*/*
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

refKeystringRequired

Datentyp

eventTypesstring[]Required

Event-Types

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

OK

delete
Path parameters
idinteger · int64Required

user id

subscriptionIdinteger · int64Required

Output Favorite id

Responses
200

OK

No content

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

OK

No content

get
Path parameters
idinteger · int64Required

user id

favoriteIdinteger · int64Required

Output Favorite id

Responses
200

OK

*/*
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

outputModuleRuleanyOptional

Search-Dialog

outputQuantityinteger · int32 · min: 1Optional

Anzahl der Ausgaben

targetOutputConsumerResultanyOptional

Search-Dialog

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

OK

put
Path parameters
idinteger · int64Required

user id

favoriteIdinteger · int64Required

Output Favorite id

Body
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

outputModuleRuleanyOptional

Search-Dialog

outputQuantityinteger · int32 · min: 1Optional

Anzahl der Ausgaben

targetOutputConsumerResultanyOptional

Search-Dialog

Responses
200

OK

*/*
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

outputModuleRuleanyOptional

Search-Dialog

outputQuantityinteger · int32 · min: 1Optional

Anzahl der Ausgaben

targetOutputConsumerResultanyOptional

Search-Dialog

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

OK

delete
Path parameters
idinteger · int64Required

user id

favoriteIdinteger · int64Required

Output Favorite id

Responses
200

OK

No content

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

OK

No content

deaktiviert eine bestehende Resource

put
Path parameters
idinteger · int64Required

identifier

Responses
200

successful operation

*/*
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

activebooleanRead-onlyOptional

Is the user active?

Default: true
usernamestringOptional

username

firstNamestringOptional

first-name

lastNamestringOptional

last-name

emailAddressstringOptional

email-address

ownerbooleanRead-onlyOptional

Is owner user?

Default: false
emailVerifiedbooleanRead-onlyOptional

is the email verified

Default: false
validTostring · date-timeOptional

Valid to

typestring · enumOptional

User type

Possible values:
appIdentifierstring · uuidRead-onlyOptional

App-Identifier

referencedCustomerUserIdinteger · int64Read-onlyOptional

Referenzierte Kundenbenutzer ID (CustomerUserEntity.id aus vab-manager)

put/cmn/users/{id}/deactivate

Provides the authorizations for a given user

get
Path parameters
idinteger · int64Required

user id

Responses
200

successful operation

*/*
superUserbooleanRead-onlyOptional

is user superuser?

Default: false
get/cmn/users/{id}/authorization
200

successful operation

Updates the authorizations for a given user

put
Path parameters
idinteger · int64Required

user id

Body
Responses
200

successful operation

*/*
superUserbooleanRead-onlyOptional

is user superuser?

Default: false
put/cmn/users/{id}/authorization

aktiviert eine bestehende Resource

put
Path parameters
idinteger · int64Required

identifier

Responses
200

successful operation

*/*
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

activebooleanRead-onlyOptional

Is the user active?

Default: true
usernamestringOptional

username

firstNamestringOptional

first-name

lastNamestringOptional

last-name

emailAddressstringOptional

email-address

ownerbooleanRead-onlyOptional

Is owner user?

Default: false
emailVerifiedbooleanRead-onlyOptional

is the email verified

Default: false
validTostring · date-timeOptional

Valid to

typestring · enumOptional

User type

Possible values:
appIdentifierstring · uuidRead-onlyOptional

App-Identifier

referencedCustomerUserIdinteger · int64Read-onlyOptional

Referenzierte Kundenbenutzer ID (CustomerUserEntity.id aus vab-manager)

put/cmn/users/{id}/activate
get
Path parameters
subscriptionIdinteger · int64Required

Output Subscription id

Responses
200

OK

*/*
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

refKeystringRequired

Datentyp

eventTypesstring[]Required

Event-Types

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

OK

put
Path parameters
subscriptionIdinteger · int64Required

Output Subscription id

Body
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

refKeystringRequired

Datentyp

eventTypesstring[]Required

Event-Types

Responses
200

OK

*/*
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

refKeystringRequired

Datentyp

eventTypesstring[]Required

Event-Types

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

OK

delete
Path parameters
subscriptionIdinteger · int64Required

Output Subscription id

Responses
200

OK

No content

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

OK

No content

get
Path parameters
favoriteIdinteger · int64Required

Output Favorite id

Responses
200

OK

*/*
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

outputModuleRuleanyOptional

Search-Dialog

outputQuantityinteger · int32 · min: 1Optional

Anzahl der Ausgaben

targetOutputConsumerResultanyOptional

Search-Dialog

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

OK

put
Path parameters
favoriteIdinteger · int64Required

Output Favorite id

Body
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

outputModuleRuleanyOptional

Search-Dialog

outputQuantityinteger · int32 · min: 1Optional

Anzahl der Ausgaben

targetOutputConsumerResultanyOptional

Search-Dialog

Responses
200

OK

*/*
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

outputModuleRuleanyOptional

Search-Dialog

outputQuantityinteger · int32 · min: 1Optional

Anzahl der Ausgaben

targetOutputConsumerResultanyOptional

Search-Dialog

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

OK

delete
Path parameters
favoriteIdinteger · int64Required

Output Favorite id

Responses
200

OK

No content

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

OK

No content

post
Path parameters
idinteger · int64Required

user id

Body
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

contentTypestring · enumRequired

ContentType

Possible values:
contentstringOptional

Content

Responses
200

OK

*/*
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

contentTypestring · enumRequired

ContentType

Possible values:
contentstringOptional

Content

post/cmn/users/{id}/signature
200

OK

post
Path parameters
idinteger · int64Required

user id

Body
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

refKeystringRequired

Datentyp

eventTypesstring[]Required

Event-Types

Responses
200

OK

*/*
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

refKeystringRequired

Datentyp

eventTypesstring[]Required

Event-Types

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

OK

post
Path parameters
idinteger · int64Required

user id

Body
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

outputModuleRuleanyOptional

Search-Dialog

outputQuantityinteger · int32 · min: 1Optional

Anzahl der Ausgaben

targetOutputConsumerResultanyOptional

Search-Dialog

Responses
200

OK

*/*
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

outputModuleRuleanyOptional

Search-Dialog

outputQuantityinteger · int32 · min: 1Optional

Anzahl der Ausgaben

targetOutputConsumerResultanyOptional

Search-Dialog

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

OK

get
Path parameters
settingKeystringRequired

setting key

Responses
200

OK

*/*
keystringRequired

setting-key

valuestringRequired

setting-value

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

OK

post
Path parameters
settingKeystringRequired

setting key

Body
stringOptional
Responses
200

OK

*/*
keystringRequired

setting-key

valuestringRequired

setting-value

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

OK

delete
Path parameters
settingKeystringRequired

setting key

Responses
200

OK

No content

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

OK

No content

post
Body
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

refKeystringRequired

Datentyp

eventTypesstring[]Required

Event-Types

Responses
200

OK

*/*
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

refKeystringRequired

Datentyp

eventTypesstring[]Required

Event-Types

post/cmn/users/me/favorites/subscription
200

OK

post
Body
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

outputModuleRuleanyOptional

Search-Dialog

outputQuantityinteger · int32 · min: 1Optional

Anzahl der Ausgaben

targetOutputConsumerResultanyOptional

Search-Dialog

Responses
200

OK

*/*
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

outputModuleRuleanyOptional

Search-Dialog

outputQuantityinteger · int32 · min: 1Optional

Anzahl der Ausgaben

targetOutputConsumerResultanyOptional

Search-Dialog

post/cmn/users/me/favorites/outputs
200

OK

Provides all Users (without hidden buildin users)

get
Responses
200

successful operation

*/*
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

activebooleanRead-onlyOptional

Is the user active?

Default: true
usernamestringOptional

username

firstNamestringOptional

first-name

lastNamestringOptional

last-name

emailAddressstringOptional

email-address

ownerbooleanRead-onlyOptional

Is owner user?

Default: false
emailVerifiedbooleanRead-onlyOptional

is the email verified

Default: false
validTostring · date-timeOptional

Valid to

typestring · enumOptional

User type

Possible values:
appIdentifierstring · uuidRead-onlyOptional

App-Identifier

referencedCustomerUserIdinteger · int64Read-onlyOptional

Referenzierte Kundenbenutzer ID (CustomerUserEntity.id aus vab-manager)

get/cmn/users
200

successful operation

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

*/*

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/{id}/available-permissions
200

successful operation

Provides the current user

get
Responses
200

successful operation

*/*
tenantIdinteger · int64Read-onlyOptional

Aktuelle Tenant-ID

managedByPartnerbooleanRead-onlyOptional

Ob der Kunde dieses Tenants von einem Partner betreut wird

get/cmn/users/me
200

successful operation

get
Responses
200

OK

*/*
keystringRequired

setting-key

valuestringRequired

setting-value

get/cmn/users/me/settings
200

OK

Provides the authorizations for the current user

get
Responses
200

successful operation

*/*
superUserbooleanRead-onlyOptional

is user superuser?

Default: false
get/cmn/users/me/authorization
200

successful operation

Provides the authorizations of a given resource for the current user

get
Path parameters
resourcestringRequired
Responses
200

successful operation

*/*

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/me/authorization/{resource}
200

successful operation

Provides all Users (without hidden buildin users)

get
Responses
200

successful operation

*/*

Related account

idstringRequired

Identifier

labelstringRead-onlyOptional

a label

descriptionstringRead-onlyOptional

a short description

activebooleanRead-onlyOptional

Activ

get/cmn/users/all
200

successful operation

Last updated

Was this helpful?