mirror of
https://github.com/m1k1o/neko.git
synced 2025-04-30 10:56:20 +02:00
71 lines
No EOL
5.5 KiB
Text
71 lines
No EOL
5.5 KiB
Text
---
|
|
id: members-update-profile
|
|
title: "Update Member Profile"
|
|
description: "Update the profile of a specific member."
|
|
sidebar_label: "Update Member Profile"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJzVWFlv4zYQ/isDLlC0giynu33yW5q6aLAn4mz7kA0CWhpLXFOklkPF6xr+78WQuuKk7RZ5al5i8fjm4BwfeRBeliQWN6LGeo2OxG0qCqTcqcYra8RCfGwK6RF8hdA4u1EawW5AAjWYq43KIe7MRCpsg07ytstCLHrEuP9D3CpS0Ugna/Qsa3FzEIplNNJXIhVG1jhsvCzEqSrXFYIq0Hi1UehYDdZqlO/wS6scFmLhXYupoLzCWorFQfh9w8jknTKlOB5veTE11hASz788+4n/PRT3NgAPVrfBkAKozXMk2rRa7zNxTMVPZz8+3sy6sj5IHjq9CFpCB7L1FduQB1ex3rk1Ho1nENk0upuZfyZGOjw2w64/Y+7Zl45d7lU0okYiWeJje0/9+At6qTQWgM5ZB92+TByPqfDKa9665Km3HeLxeAx2vnraTkJ3jw5aU6Ajb20RzqWzPoV1yy7YtIQE3gb7rVN/Iij/v7L+iRAJ1sdEwAIckm1djrCTBMZ62NjWFP8bG48xg5D8z7bYs5BvVvvr7Ik68s+2xGT/N0PYwbzyNNmPqVB0J4tamQnI2lqN0jxCuTQF644EagoDikAaCCgBMpfmTtvyWZi5NKBtCRPI3BrDLngeaIcyoO6kz6tnYgaMAbGy9FwlGWLAo0o6vKuxUPKZsAEJAtKALkMZvsu1atZWuuKZIiJcGB0ggyxCU9CdMjL36h7v8taRdc8QFvCgx4OIN/oM8VQWPdd5iKfiKMhrdFsqQ0/VHVkUiqGl/jDJ2thWH0o+H1ZCxANC75Up6WG5id205wFDtRn79TEVNfrKMndoOBLTyAsWYi4bNe8Ky/zQ04Oj4LPhzhOZxEO13thc6q4ziVS0TouFqLxvFvO55jmO1MWrs7MzwWyAMG+d8vuA9DNKh+68ZeE3t8f0IC6s3SqcjlzbLZphYIKw4qIYS9x01+Bi2ajXuBdpZD55WDJyn3fL1+/vVsvV6vL9u0eHfP6AOUBLypTMxJCIvyNWONmpBYNktl50rCjEUlj0rVIiJHi2O8iYeOBvjPvSotuPtoWt3youLIZGEmEBkkBCQIOBPsbo4lZ0NTat5VdZNxrH/jL2lbFdxCie1PpxYKjU41BXZseBWCXH7wdVbhx+XJ46Uvp0OZngPVkB4vyYsWy8MhsbnN+l2DvcWjj/cClSwVkR/fsqO8vOHnk9LA2M7A9cX11fgDQF/1zZfIse1kiqQIKr5eqaEZm3Nc7eq4J5ndQzr2oE/rRA3qGslSlTUMaj6wuN1VqubbwQpAHfYW09QoG09baBTWvyWDmU32efzCfz4sULuLAO4Rrzylg+HiSemEGS/B6krXppYJlzRu2T5JMBmEGwSuM9OlkiQZL007CxblQ8BW13My09mnyfQqXKavalDWp0NrG2si3UxLosiniN+3CcYUltW0LAezSegDuUd9JQrTzfE4J+XIqJ+Uvn5i7AONJZJUJZa247g+esyXqDr1jfa3b0SpXsJU4MU8CFrevW9AnTuyGeXO+JYHo/xDyn5TwKIkcwZXq1vseszNKhkiB5udaKqhqNT+HyYsmNpFDhJohf80qaEn/IAKKwN+G8K+lHhHhZonju285n8+ivjdR6LfNt8FglTaF7bw06jz7oA5BVX96j2/uKVV9qwtHWkxryHaw6Nd5KI0tkK5IEZrDiGo1PXcOCnr3yQSc+8t7AJLmytg5rPvLeE9gLh9KHBKhtoTb78JMXM392VgdnR6EdybDgrK1pIuCXLiku4hYKwOfF55YYGSh3iIEDblTZxqSiFGpWhOe3fxeWWS9gtSePNfyGUvsKvoO36J3Ko5wr/o33QVBcVsVleYX5lgLocLmXGpQhVVY+6h/T9je7g0sP51rDH9ZtCa5tib5Cxwt+zKa5GI+cIp0bEywccZKclJe0y0NWoZBeJkn2ybzMTgIcDbV8wZaQJA2XPvIhcteqUA67KpMkp+k3KQPTDIx2vcom8Zckff3jsrJRBmelk8rgcMhJEmN4cs5d1ePQeXBwIbp/5XsZ17oi3NUo5TtyaLChaPDzQgj8wuYtR1q/U6RCqxwNTbvceSPzCuFlqPQPuM5ut8tkmM2sK+fdVpq/ubxYvlstZy+zs6zytQ7dlGlXLc0EuHv96Z5CxlecB91kclH8L89FHWfw+NXPGy2VYVYRlD90zO+GCYVIh0tlKhbD49BtKmInvhGHw1oSfnT6eOThSDsWN7epuJdOyTU3RyaIivh3IRYbqemUyE6N+P6qY6Y/wL+9OT1pRM+GDLOfe6lb/hKp2OJ++r51vD2mokJZoAsKxumLqMbsmkHG7Y8u4MxC447zPMfG/+Pa2wm5/vB+dS1Sse4u+bUteI+TO35Ck7uoqg1uCTQ2jB2ElqZsw+uDiJj89xfOHg/Q
|
|
sidebar_class_name: "post api-method"
|
|
info_path: docs/api/neko-api
|
|
custom_edit_url: null
|
|
---
|
|
|
|
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
|
import ParamsDetails from "@theme/ParamsDetails";
|
|
import RequestSchema from "@theme/RequestSchema";
|
|
import StatusCodes from "@theme/StatusCodes";
|
|
import OperationTabs from "@theme/OperationTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
import Heading from "@theme/Heading";
|
|
|
|
<Heading
|
|
as={"h1"}
|
|
className={"openapi__heading"}
|
|
children={"Update Member Profile"}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"post"}
|
|
path={"/api/members/{memberId}"}
|
|
context={"endpoint"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
Update the profile of a specific member.
|
|
|
|
<Heading
|
|
id={"request"}
|
|
as={"h2"}
|
|
className={"openapi-tabs__heading"}
|
|
children={"Request"}
|
|
>
|
|
</Heading>
|
|
|
|
<ParamsDetails
|
|
parameters={[{"in":"path","name":"memberId","description":"The identifier of the member.","required":true,"schema":{"type":"string"}}]}
|
|
>
|
|
|
|
</ParamsDetails>
|
|
|
|
<RequestSchema
|
|
title={"Body"}
|
|
body={{"content":{"application/json":{"schema":{"x-tags":["members"],"type":"object","properties":{"name":{"type":"string","description":"The name of the member."},"is_admin":{"type":"boolean","description":"Indicates if the member is an admin."},"can_login":{"type":"boolean","description":"Indicates if the member can log in."},"can_connect":{"type":"boolean","description":"Indicates if the member can connect."},"can_watch":{"type":"boolean","description":"Indicates if the member can watch."},"can_host":{"type":"boolean","description":"Indicates if the member can host."},"can_share_media":{"type":"boolean","description":"Indicates if the member can share media."},"can_access_clipboard":{"type":"boolean","description":"Indicates if the member can access the clipboard."},"sends_inactive_cursor":{"type":"boolean","description":"Indicates if the member sends inactive cursor."},"can_see_inactive_cursors":{"type":"boolean","description":"Indicates if the member can see inactive cursors."},"plugins":{"type":"object","additionalProperties":true,"description":"Additional plugin settings."}},"title":"MemberProfile"}}},"required":true}}
|
|
>
|
|
|
|
</RequestSchema>
|
|
|
|
<StatusCodes
|
|
id={undefined}
|
|
label={undefined}
|
|
responses={{"204":{"description":"Member profile updated successfully."},"401":{"description":"The request requires user authentication.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}},"403":{"description":"The server understood the request, but refuses to authorize it.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}},"404":{"description":"The specified resource was not found.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}}}}
|
|
>
|
|
|
|
</StatusCodes>
|
|
|
|
|
|
|