|
| 1 | + |
| 2 | += changeInstallUser |
| 3 | +Updates information about the specified user. |
| 4 | + |
| 5 | +[discrete] |
| 6 | +== PUT /api/v1/superuser/users/{username} |
| 7 | + |
| 8 | + |
| 9 | + |
| 10 | +**Authorizations: **oauth2_implicit (**super:user**) |
| 11 | + |
| 12 | + |
| 13 | +[discrete] |
| 14 | +== Path parameters |
| 15 | + |
| 16 | +[options="header", width=100%, cols=".^2a,.^3a,.^9a,.^4a"] |
| 17 | +|=== |
| 18 | +|Type|Name|Description|Schema |
| 19 | +|path|**username** + |
| 20 | +_required_|The username of the user being managed|string |
| 21 | +|=== |
| 22 | + |
| 23 | + |
| 24 | +[discrete] |
| 25 | +== Request body schema (application/json) |
| 26 | + |
| 27 | +Description of updates for a user |
| 28 | + |
| 29 | +[options="header", width=100%, cols=".^3a,.^9a,.^4a"] |
| 30 | +|=== |
| 31 | +|Name|Description|Schema |
| 32 | +|**password** + |
| 33 | +_optional_|The new password for the user|string |
| 34 | +|**email** + |
| 35 | +_optional_|The new e-mail address for the user|string |
| 36 | +|**enabled** + |
| 37 | +_optional_|Whether the user is enabled|boolean |
| 38 | +|=== |
| 39 | + |
| 40 | + |
| 41 | +[discrete] |
| 42 | +== Responses |
| 43 | + |
| 44 | +[options="header", width=100%, cols=".^2a,.^14a,.^4a"] |
| 45 | +|=== |
| 46 | +|HTTP Code|Description|Schema |
| 47 | +|200|Successful invocation| |
| 48 | +|400|Bad Request|<<_apierror,ApiError>> |
| 49 | +|401|Session required|<<_apierror,ApiError>> |
| 50 | +|403|Unauthorized access|<<_apierror,ApiError>> |
| 51 | +|404|Not found|<<_apierror,ApiError>> |
| 52 | +|=== |
| 53 | + |
| 54 | + |
| 55 | +[discrete] |
| 56 | +== Example command |
| 57 | + |
| 58 | +[source,terminal] |
| 59 | +---- |
| 60 | +$ curl -X PUT "https://<quay-server.example.com>/api/v1/superuser/users/<username>" \ |
| 61 | + -H "Authorization: Bearer <bearer_token>" \ |
| 62 | + -H "Content-Type: application/json" \ |
| 63 | + -d '{ |
| 64 | + "password": "<N3wP@ssw0rd!>", |
| 65 | + |
| 66 | + "enabled": true |
| 67 | + }' |
| 68 | +---- |
0 commit comments