MDSEC User REST API
Published: 2024-05-15
Resource Name
/mdsec/user
POST
Create, update or delete a user in MDSEC. In the case of an update, the value for any parameter that isn't included in the request payload will be left as is.
QTMHHTTP must be granted the right to invoke command MDUPDUSR in MDSEC
Request
Path parameters
none
Body parameters
user required
string
The user ID of the user to register in MDSEC
opt
string
*UPDADD - If the user already exists in MDSEC, it will be updated with the provided information. Otherwise, the user will be added. *ADD - Add the provided information only if the user isn't already defined in MDSEC. *REMOVE - Remove the user from MDSEC
desc
string
a description of the user.
addr
string
the email address of the user.
extu
string
The external user ID, if mapping from LDAP for the usage of MDWorkflow.
act
string
*NO - set the user to deactivated in MDSEC *YES - set the user to activated in MDSEC.
grpa
string
Specifies if authority for the user should be based on the authority permitted for the primary group that the user belongs to.
*NO - The user's authority is based solely on the authority permitted for the user themselves. *YES - The user's authority is based solely on the authority permitted for the primary group that the user belongs to in MDSEC. *BOTH - The user's authority is based on the combination of the authority for the group and the specific user.
grpa
string
The CCSID to use for the user, instead of the CCSID defined for the MDCMS instance. This value is used for character translation between the MDCMS database and MDOpen/MDWorkflow. Not all values are accepted in MDSEC - check the permitted values first by listing them from the MDCMS system settings.
addroles
array(string)
The list of up to 20 MDSEC authority roles to apply to the user
rmvroles
array(string)
The list of up to 20 MDSEC authority roles to revoke for the user
Example:
{ "user": "SOMEUSER", "desc": "some user to be registered in MDSEC", "addr": "someuser@mdcms.ch", "ccsid": "37", "addroles": ["MD_ADMCMS", "MD_RFP_SBM"], "rmvroles": ["MD_PGMR"] }
Response
Body parameters
The response provides a structure with the following parameters:
msg
string
A description of the result of the attempt to create/update/delete the user
sev
string
message severity with 10=ok, 20=warning and 30=error
Example: