From 7d75d30ebb3f6fddce8a5ed98c45eb154c96561c Mon Sep 17 00:00:00 2001 From: Steven Smith Date: Tue, 9 Sep 2025 15:22:16 -0400 Subject: [PATCH] Adds ChangeInstallUser API endpoint to docs --- modules/api-superuser-changeInstallUser.adoc | 68 ++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 modules/api-superuser-changeInstallUser.adoc diff --git a/modules/api-superuser-changeInstallUser.adoc b/modules/api-superuser-changeInstallUser.adoc new file mode 100644 index 000000000..53a5f8415 --- /dev/null +++ b/modules/api-superuser-changeInstallUser.adoc @@ -0,0 +1,68 @@ + += changeInstallUser +Updates information about the specified user. + +[discrete] +== PUT /api/v1/superuser/users/{username} + + + +**Authorizations: **oauth2_implicit (**super:user**) + + +[discrete] +== Path parameters + +[options="header", width=100%, cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|path|**username** + +_required_|The username of the user being managed|string +|=== + + +[discrete] +== Request body schema (application/json) + +Description of updates for a user + +[options="header", width=100%, cols=".^3a,.^9a,.^4a"] +|=== +|Name|Description|Schema +|**password** + +_optional_|The new password for the user|string +|**email** + +_optional_|The new e-mail address for the user|string +|**enabled** + +_optional_|Whether the user is enabled|boolean +|=== + + +[discrete] +== Responses + +[options="header", width=100%, cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|200|Successful invocation| +|400|Bad Request|<<_apierror,ApiError>> +|401|Session required|<<_apierror,ApiError>> +|403|Unauthorized access|<<_apierror,ApiError>> +|404|Not found|<<_apierror,ApiError>> +|=== + + +[discrete] +== Example command + +[source,terminal] +---- +$ curl -X PUT "https:///api/v1/superuser/users/" \ + -H "Authorization: Bearer " \ + -H "Content-Type: application/json" \ + -d '{ + "password": "", + "email": "", + "enabled": true + }' +---- \ No newline at end of file