Skip to content

GroupApi.md

Latest commit

 

History

History
447 lines (248 loc) · 14.6 KB

GroupApi.md

File metadata and controls

447 lines (248 loc) · 14.6 KB

\GroupApi

All URIs are relative to https://q.trap.jp/api/v3

Method HTTP request Description
add_user_group_admin POST /groups/{groupId}/admins グループ管理者を追加
add_user_group_member POST /groups/{groupId}/members グループメンバーを追加
change_user_group_icon PUT /groups/{groupId}/icon ユーザーグループのアイコンを変更
create_user_group POST /groups ユーザーグループを作成
delete_user_group DELETE /groups/{groupId} ユーザーグループを削除
edit_user_group PATCH /groups/{groupId} ユーザーグループを編集
edit_user_group_member PATCH /groups/{groupId}/members/{userId} グループメンバーを編集
get_user_group GET /groups/{groupId} ユーザーグループを取得
get_user_group_admins GET /groups/{groupId}/admins グループ管理者を取得
get_user_group_members GET /groups/{groupId}/members グループメンバーを取得
get_user_groups GET /groups ユーザーグループのリストを取得
remove_user_group_admin DELETE /groups/{groupId}/admins/{userId} グループ管理者を削除
remove_user_group_member DELETE /groups/{groupId}/members/{userId} グループメンバーを削除
remove_user_group_members DELETE /groups/{groupId}/members グループメンバーを一括削除

add_user_group_admin

add_user_group_admin(group_id, post_user_group_admin_request) グループ管理者を追加

指定したグループに管理者を追加します。 対象のユーザーグループの管理者権限が必要です。

Parameters

Name Type Description Required Notes
group_id uuid::Uuid ユーザーグループUUID [required]
post_user_group_admin_request Option<PostUserGroupAdminRequest>

Return type

(empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

add_user_group_member

add_user_group_member(group_id, add_user_group_member_request) グループメンバーを追加

指定したグループにメンバーを追加します。 対象のユーザーグループの管理者権限が必要です。

Parameters

Name Type Description Required Notes
group_id uuid::Uuid ユーザーグループUUID [required]
add_user_group_member_request Option<AddUserGroupMemberRequest>

Return type

(empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

change_user_group_icon

change_user_group_icon(group_id, file) ユーザーグループのアイコンを変更

ユーザーグループのアイコンを変更します。 対象のユーザーグループの管理者権限が必要です。

Parameters

Name Type Description Required Notes
group_id uuid::Uuid ユーザーグループUUID [required]
file std::path::PathBuf アイコン画像(2MB,Config.Imaging.MaxPixels(default: 2560*1600)までのpng, jpeg, gif) [required]

Return type

(empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_user_group

crate::models::UserGroup create_user_group(post_user_group_request) ユーザーグループを作成

ユーザーグループを作成します。 作成者は自動的にグループ管理者になります。

Parameters

Name Type Description Required Notes
post_user_group_request Option<PostUserGroupRequest>

Return type

crate::models::UserGroup

Authorization

OAuth2, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_user_group

delete_user_group(group_id) ユーザーグループを削除

指定したユーザーグループを削除します。 対象のユーザーグループの管理者権限が必要です。

Parameters

Name Type Description Required Notes
group_id uuid::Uuid ユーザーグループUUID [required]

Return type

(empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_user_group

edit_user_group(group_id, patch_user_group_request) ユーザーグループを編集

指定したユーザーグループの情報を編集します。 対象のユーザーグループの管理者権限が必要です。

Parameters

Name Type Description Required Notes
group_id uuid::Uuid ユーザーグループUUID [required]
patch_user_group_request Option<PatchUserGroupRequest>

Return type

(empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_user_group_member

edit_user_group_member(group_id, user_id, patch_group_member_request) グループメンバーを編集

指定したユーザーグループ内の指定したユーザーの属性を編集します。 対象のユーザーグループの管理者権限が必要です。

Parameters

Name Type Description Required Notes
group_id uuid::Uuid ユーザーグループUUID [required]
user_id uuid::Uuid ユーザーUUID [required]
patch_group_member_request Option<PatchGroupMemberRequest>

Return type

(empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_user_group

crate::models::UserGroup get_user_group(group_id) ユーザーグループを取得

指定したユーザーグループの情報を取得します。

Parameters

Name Type Description Required Notes
group_id uuid::Uuid ユーザーグループUUID [required]

Return type

crate::models::UserGroup

Authorization

OAuth2, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_user_group_admins

Vecuuid::Uuid get_user_group_admins(group_id) グループ管理者を取得

指定したグループの管理者のリストを取得します。

Parameters

Name Type Description Required Notes
group_id uuid::Uuid ユーザーグループUUID [required]

Return type

Vecuuid::Uuid

Authorization

OAuth2, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_user_group_members

Veccrate::models::UserGroupMember get_user_group_members(group_id) グループメンバーを取得

指定したグループのメンバーのリストを取得します。

Parameters

Name Type Description Required Notes
group_id uuid::Uuid ユーザーグループUUID [required]

Return type

Veccrate::models::UserGroupMember

Authorization

OAuth2, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_user_groups

Veccrate::models::UserGroup get_user_groups() ユーザーグループのリストを取得

ユーザーグループのリストを取得します。

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::UserGroup

Authorization

OAuth2, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

remove_user_group_admin

remove_user_group_admin(group_id, user_id) グループ管理者を削除

指定したユーザーグループから指定した管理者を削除します。 対象のユーザーグループの管理者権限が必要です。 グループから管理者が存在しなくなる場合は400エラーを返します。

Parameters

Name Type Description Required Notes
group_id uuid::Uuid ユーザーグループUUID [required]
user_id uuid::Uuid ユーザーUUID [required]

Return type

(empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

remove_user_group_member

remove_user_group_member(group_id, user_id) グループメンバーを削除

指定したユーザーグループから指定したユーザーを削除します。 既にグループから削除されているメンバーを指定した場合は204を返します。 対象のユーザーグループの管理者権限が必要です。

Parameters

Name Type Description Required Notes
group_id uuid::Uuid ユーザーグループUUID [required]
user_id uuid::Uuid ユーザーUUID [required]

Return type

(empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

remove_user_group_members

remove_user_group_members(group_id) グループメンバーを一括削除

指定したグループから全てのメンバーを削除します。 対象のユーザーグループの管理者権限が必要です。

Parameters

Name Type Description Required Notes
group_id uuid::Uuid ユーザーグループUUID [required]

Return type

(empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]