System-level user account resources

Content Platform Tenant Management Help

Version
9.7.x
File Size
4269 KB
Audience
anonymous
Part Number
MK-95HCPH002-19

The system-level user account resources let you retrieve a list of the system-level user accounts, retrieve information about a system-level user account, and change the password for a locally authenticated system-level user account. The table below provides information about these resources.

.../userAccounts

Data Type Method Use Access Notes
List GET Retrieve a list of the system-level user accounts. System-level user account with the monitor, administrator, or security role

The listed user accounts are identified by the account username.

In XML, the element that identifies each user account is username. The root element for the list of user accounts is userAccounts.

In JSON, the name in the name/value pair that lists the user accounts is username.

.../userAccounts/username

Data Type Method Use Access Notes
userAccount GET Retrieve information about a system-level user account. System-level user account with the monitor, administrator, or security role
N/A HEAD Check for the existence of a user account. System-level user account with the monitor, administrator, or security role
N/A POST Change the password for a locally authenticated system-level user account. System-level user account with the security role The required query parameter for changing user account passwords is password=password.

.../userAccounts/username/changePassword

Data Type Method Use Access Notes
updatePasswordRequest POST Change the password for a locally authenticated system-level user account. System-level user account with the security role