mirror of
https://github.com/m1k1o/neko.git
synced 2025-04-29 18:36:22 +02:00
71 lines
No EOL
6.9 KiB
Text
71 lines
No EOL
6.9 KiB
Text
---
|
|
id: members-create
|
|
title: "Create Member"
|
|
description: "Create a new member."
|
|
sidebar_label: "Create Member"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztWUtv4zgS/isFNjDYFWQ5k96Tb5m0BxP0E7Fn55AOAloqS2xTpJpFxfEG/u+LIiVLcZJBgMwcBuhcYlPFrx6s+qpE3wsvSxKzK1FjvUJH4joVBVLuVOOVNWImzh1KjyDB4BaiVCZSYRt0kkUuCjHrd0dZkQqH1FhDSGJ2L05PTvjfQ9iPYQfkYUcB1OY5Eq1brXcMn1vj0XjeJ5tGqzzomn4j3nwvKK+wlvzJ7xoUM2FX3zD3IhWNY8u8iqpVMZIh75QpxbGDywqhNep7i6AKNF6tFTqwa/AVHhzeB+S10siAd5MnwvbnlhhZ48tsYckn1Cu6kUWtzAhkZa1GaR6hXJiCA4YEagwDikAaCCgBMpfmRtvyVZi5NKBtCSPI3BrDIXgdaIdyQN1Kn1evxAwYB8TK0muNZIgDHlXS4U2NhZKvhA1IEJAO6DIUyE2uVbOy0hWvVBHhwuoBMugiNAXdKCNzr27xJm8dWfcKZQEPejyIeEPMEI910WuDh3isjmIB67ZUhp5iDVkUiqGl/jKqWu9aPNZ8dpCEiAeE3itTso59KrzyzBEdv33pOOOpOu/4BJRZW1cHfntU9o8A30kvxX7PD/5z8vNjWmVgh99bJB/+K4cELaED2fqK2S0y6V/IsTUSyfIF5PYOvVQaC0DnrINu30Mv5/zoY4fY+/n2aT8J3S06aE2Bjry1RYhd530Kq5ZDsG4JCbwN/lun/oeg/D/J+9PTZ5vnVvkK8soSGrh4B1I7lMUO8E6Rp3+Mj3seF8KZ/WKLHSv5i8zmtH952+2l+xocjztMHpJoa90L54le+jmwH6PEj1HixyjxY5T4+0eJB8zzCLR7YTuQsHJYRGP3qajRV5bf7hrObqZAX4mZmMpGTXuy4kPmLswMdtylPthc6q5Li1S0TouZqLxvZtOp5mec8rO3JycnYn/NQHnrlN8FpF9QOnRnLWu8ut6n9+Lc2o3C8crSbtAcFkYIC24QkSvHuw5nJRv1HnciFUxXIg8iIu14VXyav/98s5gvFhefPz2K9tmDKQpaUqYECYRE/D1ihRQZe3DQzN5zzIKBnJRB6KVaIiR49jvoGEXgGee+t+h2g29h60vVBeHQyrAASSAhoEEjnazR9xnFbflyaODzO1k3sbcNDXhoUkMfHa0N7fBYfGhVsYJGfWZYOHSJYamj+GEhMvTw/QHDDsuPqTE+e4bKRnhPsk98PrBFKDSu0nBgXSl+wo2Fsy8XIhVcSfFM3mYn2cmjkwqiYaL9A1eXy3OQpuCPC5tv0MMKSRVIcDlfLBmR597G2VtV8Fws9cSrGoG/WiDvUNbKlCko49H1LGe1lisb73bSgO+wth6hQNp428C6NXmkLeV32Vfz1bx58wbOrUNYYl4Zy+eDxA8mkCT/DdoWvTawPLNH65PkqwGYQPBK4y06WSJBkvSPYW3dYHgK2m4nWno0+S6FSpXV5HsbzOh8YmtlW6iRd1lU8R534TyDSG1bQsBbNJ6A26N30lCtPN9EBfuYOYmHpy7MXYZxdbBJhLLW3PMOkbMm6x2+ZHuXHOiFKjlKXEymgHNb163pi6wPQzy5PhLB9X6Jh6yWay+oHMCU6c36F2Zllh7YB8nLlVZU1Wh8Chfnc+5ihSr4Ag/v8kqaEv+dAURlH8J5V9IPCG3DshTPfdPFbBrjtZZar2S+CRGrpCl0H62DzUMM+gRk0+e36Ha+YtPnmnDw9Yh3foJFZ8ZHaWSJ7EWSwAQWzOv41GtssLM3PtjER947mCSX1tZB5nfeewQbml8ogNoWar0LH1mY3z+c1SHYUWk34Vhw1tY0UvCuK4rzuIUC8FnxrSVGBsodYhhA16psY1FRCjUbws83z6Vl1itY7MhjDb+h1L6Cn+AjeqfyqOeSP+NtUBTFqiiWV5hvKIAe7mmlBmVIlZWP9sey/c1u4cLDmdbwh3UbgqUt0VfoWODnbFyL8cgpzpJDgYUjTpIjekm7OmQTCullkmRfzWl2lOBoqOULCglJ0jD1kQ+Zu1KFctixTJIcl9+IBsYVGP16m43yL0l6/mNaWSuDk9JJZfBwyEkSc3h0zh3rceo8OLiQ3b/yey1zXRHedSnlO4bQlANp8AV2SPzC5i1nWr9TpEKrHA2N29xZI/MK4TQw/YP5aLvdZjI8zawrp91Wmn64OJ9/Wswnp9lJVvlahw7M81ktzQi4u7SPQ95xFxm9YD93u9/NEh7v/LTRUhmeNoKB990YeMWDhkjHb62xxV6J+/uVJPzd6f2el+MIMru6TsWtdEquuOnxBCcqlAW6MO9tcMfWRLsmS1bP4rqNI83RJQBPf3HHWZ5j4/9U9no0yX75vFiKVKy6i4baFrzHyS3/ZiG3YibCTxshm1ggrN0LLU3ZhhsQETH57/9Cq9G0
|
|
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={"Create Member"}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"post"}
|
|
path={"/api/members"}
|
|
context={"endpoint"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
Create a new member.
|
|
|
|
<Heading
|
|
id={"request"}
|
|
as={"h2"}
|
|
className={"openapi-tabs__heading"}
|
|
children={"Request"}
|
|
>
|
|
</Heading>
|
|
|
|
<ParamsDetails
|
|
parameters={undefined}
|
|
>
|
|
|
|
</ParamsDetails>
|
|
|
|
<RequestSchema
|
|
title={"Body"}
|
|
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"username":{"type":"string","description":"The username of the new member."},"password":{"type":"string","description":"The password of the new member."},"profile":{"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","description":"The profile information of the new member."}},"title":"MemberCreate"}}},"required":true}}
|
|
>
|
|
|
|
</RequestSchema>
|
|
|
|
<StatusCodes
|
|
id={undefined}
|
|
label={undefined}
|
|
responses={{"200":{"description":"Member created successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the member."},"profile":{"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","description":"The profile information of the member."}},"title":"MemberData"}}}},"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"}}}},"422":{"description":"Member with chosen ID already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}}}}
|
|
>
|
|
|
|
</StatusCodes>
|
|
|
|
|
|
|