neko/webpage/docs/api/profile.api.mdx
2025-03-22 17:52:56 +01:00

71 lines
No EOL
4.8 KiB
Text

---
id: profile
title: "Update Profile"
description: "Update the current user's profile without syncing it with the member profile (experimental)."
sidebar_label: "Update Profile"
hide_title: true
hide_table_of_contents: true
api: eJy1WFtv27gS/isDFtiLIMvZdp/8lvV6sUFvQeyefUiDgJbGEmuKVDmUHSPwf18MKVmK0y4KBCcvscnhNxfOfDP0o/CyJDG7FXnrHBo/ISRS1oi7VBRIuVON568z8akppEfwFUInCy2h+5mgcXajNMJe+cq2HuhgcmVKUD4shSM11mt0J9Ff8KFBp2o0XupfM5EK26CTrOqqEDPRyYlUOKTGGkISs0fx+uJ3/vfUsOsOsw0GFkBtniPRptX6kIljKn6/+O35qVWF4PBri+TDf+WQgkMgW1+h8SoP5rBtuTUejWcQ2TS625l+IUZ6FJRXWEv+5A8Nipmw6y+Ye5GyGw06r6L1NRLJEkeC5J0ypTgP9Z/opdJYADpnHXTnMnE8psIrr/nogrfed4hH/uNYBX/+sMWBlfyw2Q+TPgviNRHf/n/7YmT9A45wkFkS7GaUBeFSFN3LolZmBLK2VqM0z1CuTMG2I4Eaw4AikAYCSoDMpbnXtnwRZi4NaFvCCDK3xnAIXgbaoZxQ99Ln1QsxA8YJsbL0UiMZ4oRHlXR4X2Oh5AthAxIEpBO6DEV6n2vVrK10xQtVRLjITj1k0EVoCrpXRuZe7fA+bx1Z9wJlAQ96PIh4Q8wQz3XRS4OHeK6Ogr5Gt6Uy9C3ekUWhGFrq61HVetfiuebLkyREPCD0XpmSntLN+2BQR7XixDbKYRGBj6mo0Vc2sDdnYioa6SsxE1PZqOlA6IRuxxQzuz2n5Hc2lxrivkhF67SYicr7Zjadat7j9Jy9ubi4EMc7Bspbp/whIP2B0qG7bFnj7d0xfRRza7cKxysru0VzWhghLJkJI6+NT53iKhv1Fg8iFUwtIg8iIu04UHxYvP14v1wsl1cfPzy72csnzQRa4sYooeuyELHCdY49OGlm7zlmwUBOoCD0o1oiJHj2O+gYReA7zn1t0R0G38LRH1UXhKGRRFiAJJAQ0KCRTtboA/EfU8H952boVIsHWTcah6YyNJOhR8TUHRH8sHCi52Gp49ZhIVLj8P0JtQ3Lzzkp7n2HQ0Z43yz7uD+UKTuvzMaG4Hd19QG3Fi6vr0QquCpifN9kF9nFs6gH0ZaQ4B9c36zmIE3BH5c236KHNZIqkOBmsVwxInjL49ZOFTzoSD3xqkbgrxbIO5S1MmUKynh0PbtYreXaxjksDfgOa+sRCqSttw1sWpNHulD+kH02n82rV69gbh3CCvPKWL4eJN6YQJL8L2hb9trA7tB11ifJZwMwgeCVxh06WSJBkvTbsLFuMDwFbfcTLT2a/JBCpcpq8rUNZnQ+sbWyLdTIuyyqeIuHcJ1BpLYtIeAOjSfgtuSdNFQrz6NjsI/5l3ho6cLcJRhnOptEKGvNveYUOWuy3uEbtnfFgV6qkqPEhWEKmNu6bk1fMH0Y4s31kQiu90s83LRcR0HlAKZMb9YvmJVZemISJC/XWlHFM3UKV/MFd49ChaEdH/JKmhJ/zQCisnfhvivpB4Q4P1O8920Xs2mM10ZqvZb5NkSskqbQfbRONg8x6BOQTV/s0B18xaYvNOHg6xmH/ATLzoz30sgS2YskgQksmaPxW5N5sLM3PtjEV947mCQ31tZB5hOfPYOdO5Q+FEBtC7U5hI8szEOzszoEOyrtJgsLztqaRgr+7IpiHo9QAL4svrTEyEC5QwyD30aVbSwqSqFmQ3h/+720zHoFywN5rOFvlNpX8BO8R+9UHvXc8GfcBUVRrIpieYX5lgLo6U0lNShDqqx8tD+W7d92D1ceLrWGf6zbEqxsib5CxwK/ZeNajFdOcYYbCixccZKc0Uva1SGbUEgvkyT7bF5nZwmOhlp+c0lIkoapj3zI3LUqlMOOZZLkvPxGNDCuwOjXm2yUf0nS8x/TykYZnJROKoOnS06SmMOje+5Yj1PnycWF7P6LH2PMdUV4oFEKDjehwQbS4BdnSPzC5m142nYnRSq0ytHQuMtdNjKvEF4Hpn8y6+z3+0yG3cy6ctodpem7q/niw3IxeZ1dZJWvdeimPGvV0oyAu4f69WnietJGRs/C//eTvhswPD74aaOlMjyCBE8fu9nwlqeP+LYMtt6lIrbqW/H4uJaEn5w+Hnk5ziWz27tU7KRTcs3dk8c6UaEs0IUhcIsHMRPz6N9kxepZXLdxzjl7AvNIGE9c5jk2/j9l70bj7fXH5UqkYt09s2tb8Bkn9/xzhdyLmQi/Z4S0ZIGw9ii0NGUb3v8iYvLfv5jyHXU=
sidebar_class_name: "post api-method"
info_path: docs/v3/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 Profile"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/api/profile"}
context={"endpoint"}
>
</MethodEndpoint>
Update the current user's profile without syncing it with the member profile (experimental).
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={undefined}
>
</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":"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"}}}}}}
>
</StatusCodes>