mirror of
https://github.com/m1k1o/neko.git
synced 2025-04-29 18:36:22 +02:00
63 lines
No EOL
5.4 KiB
Text
63 lines
No EOL
5.4 KiB
Text
---
|
|
id: whoami
|
|
title: "Get Current User"
|
|
description: "Retrieve information about the current user session."
|
|
sidebar_label: "Get Current User"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJzVWE2P2zgS/SsFBhjsCrLsSfbkW4/jTRr5mKDdM3PoNBq0VJYYU6TCotzxNvzfB0VKstrdmQ3Ge9mTbZF8r+qxvuQH4WVJYn4j8tY5NH5CSKSsEbepKJBypxrPP+fiCr1TuENQZmNdLfkxyLVtPfgKoTsPLaGDDiQTqbANurD3shBzcV9ZWSuRCofUWENIYv4gXs5m/PGYbzEGHHO6zpACqM1zJNq0Wu+ZK7fGo/GMJZtGqzwcmH4hBnwQlFdYS/7m9w2KubDrL5h7kYrGsZleRXNUMdpD3ilTilM1riuE1qivLYIq0Hi1UejAboIWg/uHAL1RGp/6xwjd4iP3Ogx2m336NulvqMZ6jY74Zv7afiNr/DEPeGdPGOGDzYruZFErMwJZW6tRmicol6ZgmZFAjWFAEUgDASVA5tLcaVuehZlLA9qWMILMrTEswXmgHcqAei99Xp2JGTAGxMrSuUYyxIBHlXR4V2Oh5JmwAQkC0oAuQ1rd5Vo1aytdcSZFhItVoocMXISmoDtlZO7VDu/y1pF1Z5AFPOjxIOIdNUM85aJzxUM8paOY9botlaHnao0sCsXQUn8aZa13LZ4yXww7IeIBoffKlMxxSIVXnguL+BAM+tQVGtbVS/+ditOX6bDlSb36b5VFUZ9x+LeCItZyggGkLzchW7hKnQHaYzwWZxV9WwVJnll4Lb0UhwOv/Gv28/OiOfzaIvnwqRxSpJStr7jyxy7zP+w/NRLJ8gdK+Gv0UmksAJ2zDrpzj/1f8tKHDrH389XzfhK6HTpoTYGOvLVF0LfzPoV1yxJsWkICb4P/1qn/ICj/f+P9IRU1+sryMFJiYJe+EnMxlY2aDuNJVILb7qlO720udaeUSEXrtJiLyvtmPp1qXuM6PX81m83E4ZaB8tYpvw9Iv6B06C5aJry5PaQPYmHtVuH4ybXdohkejBBWrF+UaHxqUEk26h3uRSq4x4o8bBFpNwyIj8t3v96tlqvV5a8fnyh58SiSoSVlSpB9WYCIFVJ17MHAzN6zZsFAztyw6UdZIiR49jtwjBT4jnNfW3T7o2/h6I/Shc3QSCIsQBJICGjQSCdr9GEC4ppkNjbwd4H0EbcWLj5dilRwYESKV9ksmz0hDltDkvyB66vrBUhT8NeVzbfoYY2kCiS4Wq6uGZFTqXF2pwpONaknXtUI/NMCeYeyVqZMQRmPru80Vmu5tnGuTgO+w9p6hAJp620Dm9bksXUov88+m8/mxYsXsLAO4RrzyliexZB4YQJJ8ntgW/VsYLkMROuT5LMBmEDwSuMOnSyRIEn6ZdhYdzQ8BW3vJ1p6NPk+hUqV1eRrG8zofGJrZVuokXdZpHiH+zAbhC21bQkBd2g8AY8o3klDtfIei2hf6Fw8wHYyd02FL5tNIpS15rljUM6arHf4iu29ZqFXqmSVODZMAQtb163pY6aXId5cr0RwvX/EjaflUAqURzBlerP+gVmZpUMyIXm51oqqGo1P4XKx5EmiUAX3Y/yWV9KU+M8MIJK9D/ddSX9EaBveS/Het51m06jXRmq9lvk2KFZJU+hercHmowZ9ALLpyx26vef2CUtNePT1JI1+gq5vwgdpZInsRZLABFZcpvC5zhjs7I0PNvGV9w4myZW1ddjzG589gV04lD4kQG0LtdmHr7yZu42zOogdSbsp04KztqYRwesuKRbxCAXgi+JLS4wMlDvE8BKwUWUbk4pSqNkQXt9+LyyznmC1J481vEWpfQU/wQd+Q80jT/faHIjitipuyyvMtxRAh3dkqUEZUmXlo/0xbd/ae7j0cKE1/GHdluDalugrdLzh52yci/HKKc7zxwQLV5wkJ+Ul7fKQTSikl0mSfTYvs5MAR0MtzzwSkqTh0kc+RO5aFcphV2WS5DT9RmVgnIHRr1fZKP6SpK9/XFY2yuCkdFIZHC45SWIMj+65q3ocOo8uLkT3v3kc4FpXhBGBUh5bQo8JRYP/LwiBX9i85UjrT4pUaJWjITy+RouLRuYVwstQ6R+1+/v7+0yG1cy6ctodpen7y8Xy42o5eZnNssrXOjSUxpKvpRkBv0EP/Z8cHPqnjeThOFH93T9fuu7p8ZufNloqw/01+PDQzT033FpF2v8xc5uK+Kp6Ix4e1pLwN6cPB34ce+785jYVO+mUXHNb5JFFVCgLdGHA2eKeFctzbHi02kndxu59Mg7yXDOMYW+W1+Jw+BPHSniv
|
|
sidebar_class_name: "get 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={"Get Current User"}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"get"}
|
|
path={"/api/whoami"}
|
|
context={"endpoint"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
Retrieve information about the current user session.
|
|
|
|
<ParamsDetails
|
|
parameters={undefined}
|
|
>
|
|
|
|
</ParamsDetails>
|
|
|
|
<RequestSchema
|
|
title={"Body"}
|
|
body={undefined}
|
|
>
|
|
|
|
</RequestSchema>
|
|
|
|
<StatusCodes
|
|
id={undefined}
|
|
label={undefined}
|
|
responses={{"200":{"description":"Current user information retrieved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the session."},"profile":{"description":"The profile information of the user.","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"},"state":{"description":"The current state of the session.","type":"object","properties":{"is_connected":{"type":"boolean","description":"Indicates if the user is connected."},"is_watching":{"type":"boolean","description":"Indicates if the user is watching."}},"title":"SessionState"}},"title":"SessionData"}}}},"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"}}}}}}
|
|
>
|
|
|
|
</StatusCodes>
|
|
|
|
|
|
|