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

71 lines
No EOL
5.4 KiB
Text

---
id: members-get-profile
title: "Get Member Profile"
description: "Retrieve the profile of a specific member."
sidebar_label: "Get Member Profile"
hide_title: true
hide_table_of_contents: true
api: eJzVWF1z27YS/Ss7yEyn5VCSm+RJb76uburJRzOW2z44Hg9ErEhEIMBgQTmqRv+9swBJ0bJzbzp+6pMoAjhnd7E4u+BeBFmSmN+IGusVehK3uVBIhddN0M6KubjC4DVuEUKF0Hi31gbBrUECNVjotS4grZ2KXLgGveSFl0rMe8w3GD6mdSIXjfSyxsBU85u90EzRyFCJXFhZ47DqUolTS64rBK3QBr3W6NkGNulI7vFLqz0qMQ++xVxQUWEtxXwvwq5hZApe21IcDrc8mRpnCYnHX56d8c9DuvcReHDZd3FQQG1RING6NWbHvIWzAW1gBNk0RhcxArPPxDD7kRlfJ09Eu7PNrT5jEThAnoMYdLIsxeTUg6ciwzNPY3LIhaY7qWptRyAr5wxK+wjl0iq2HQn0GAY0gbQQUSJkIe2dceWzMAtpwbgSRpCFs5ZD8DzQDmVAvZehqJ6JGTEGxMrRc41kiAGPKunxrkal5TNhIxJEpAFdxly9K4xuVk569UyKBBffDpCRi9AqutNWFkFv8a5oPTn/DLKIBz0eJLxjzBBPuei5wUM8paPI15i21HYMP5xVqZRmaGk+jk5tUp+HzOfDTEh4QBiCtiVzHHIRdDA4iE4vl4cDj70++/mxOvGRZ8FDCtAJH0FL6EG2oWKRTDL0jwTqf2tRjUSy/A45+gWD1AYVoPfOQ7fuoaMLHnrfIfZ+vnraT0K/RQ+tVegpOKfi3nXe57BqOQTrlpAguOi/8/ovBB3+Vd6//ob3qcyiAo/kWl8g3EsC6wKsXWvVv8bHQy5qDJXj1qDEyM6Ffy5mstGzriTO9n39PwhWFd751Co8tOCdK6TpMkPkovVGzEUVQjOfzQyPscbOX52dnQku94RF63XYRaT/oPToz1smv7k95Htx4dxG4/jNtdugHV6MEJYcyxSu8aohYrLRb3En8tTaFHHKsbn5sHj7291ysVxe/vbhUVTPH5xcaEnbkvssJOL/CStq0tiDgZm9F13bE1UwTvpelgQJgf2OHKMIfMO5Ly363dG3uPR76eJkaCQRKpAEEiIaDP1hSiZt1y7yd0n1ATcOzj9eilxwYiSKV9Oz6dkj4jg1isKfuLq6vgBpFT8uXbHBACskrZDgarG8ZkSWjsa7rVYsLdJMgq4R+K8DCh5lrW2Zg7YBfV8lnDFy5VLHm0d8j7ULCAppE1wD69YWSfZ12E0/2U/2xYsXcOE8wjUWlXXcRyHxwASy7I/ItuzZwLHsJeuz7JMFmED0yuAWvSyRIMv6YVg7fzQ8B+PuJ0YGtMUuh0qX1eRLG83ofGJrZav0yLtponiLu1jX45TatYSAW7SBgNuL4KWlWoeAKtnHWkzcfHZh7jow3mw2iVDWhnuGIXLOTnuHr9jeaw70UpccJc4Nq+DC1XVr+5zpw5B2ro9EdL1/xU1qy6kUKY9g2vZm/YjTcpoPhwkpyJXRVNVoQw6XFwvuApRWMiDg16KStsSfpgCJ7F3c70qGI0Lb8FxK+77pYjZL8VpLY1ay2MSIVdIq00drsPkYgz4B2fTFFv0uVGz6whAefT05Rj/AsjPjvbSyRPYiy2ACS5YpfKoTiHb2xkebeMt7B7Psyrk6zvmd157AXniUIR6A2im93sVHnsyVxzsTg51Iuw7RgXeuphHBL92huEhLKAKfq88tMTJQ4RFjA7/WZZsOFeVQsyE8vvlWWk57guWOAtbwK0oTKvgB3vOVrUg83TU2EqVpVZpWVFhsKIIOt1dpQFvSZRWS/enY/uru4TLAuTHwp/MbgmtXYqjQ84Sfp+OzmLacUi9+PGBxi7PsRF7y7hyyCUoGmWXTT/bl9CTB0VLLPZ6ELGtY+ijEzF1ppT12KpNlp8dvJAPjE5j8ejUd5V+W9frHsrLWFiell9risMlZlnJ4tM+d6nHqPNi4mN3/5daAtU7FdoFybtNijYmiwRfomPjKFS1nWr9S5MLoAi3h8QoszhtZVAgvo9I/KPf39/dTGUenzpezbinN3l1eLD4sF5OX07NpFWoTC0rjKNTSjoDfYIDurn/8TPGglOyP/dU/+xzSVc2AX8OsMVJbrqvR9n3X+9xwSRX58EEgF/Ph+8dtLtJd80bs9ytJ+Ls3hwO/ToV3fnObi630Wq64NnKLpImflZivpaHTS8jYjR+vuo8lP8H/+6zypBN9P2C5/m+lafmfyMUGd+NPOIfbQy4qlAp9NDANnxcFNmG08FHPyg3X0Cu+WVyLw+FvytB+LA==
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 Member Profile"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/api/members/{memberId}"}
context={"endpoint"}
>
</MethodEndpoint>
Retrieve 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={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Member profile retrieved successfully.","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"}}}},"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>