GroupsPOST
参加承認モードの設定
グループの参加承認のオン / オフを切り替えます。enabled は必須のブール値で、true の場合は新メンバーが承認を経ないと参加できません。
https://api.unifyport.ai/v1/accounts/{account_id}/groups/join-approval-modeヘッダー
X-Api-Keystring必須
ワークスペース API キー。このヘッダーからワークスペースを特定します。
Content-Typestring必須
JSON のリクエストボディを送る場合は application/json を使用します。
パスパラメータ
account_idstring必須
groups ルートで使用される識別子。
リクエストボディ
group_idstring必須
対象グループ識別子。
enabledboolean必須
新規メンバーに管理者承認を要求するかどうか。
レスポンスボディ
okboolean
操作が成功したときは常に true。失敗時は代わりに 2xx 以外のステータスが返ります。
レスポンス
200200 OK
リクエスト成功。レスポンスボディの例を参照してください。
400Bad Request
リクエストボディ、パス、またはパラメータが不正です。
401Unauthorized
X-Api-Key ヘッダが欠落しているか無効です。
404Not Found
要求されたプロバイダリソースが見つかりません。
409Conflict
要求された操作が、既存のプロバイダアカウントまたはリソースと競合しています。
500Internal Server Error
サービスで予期しないエラーが発生しました。
501Not Implemented
選択したプロバイダはこの操作を実装していません。
502Bad Gateway
プロバイダアダプタまたは上流サービスが操作を完了できませんでした。
リクエスト
curl -X POST https://api.unifyport.ai/v1/accounts/{account_id}/groups/join-approval-mode \
-H "X-Api-Key: <YOUR_API_KEY>" \
-H "Content-Type: application/json" \
-d '{
"group_id": "group_example",
"enabled": true
}'レスポンス
{
"data": {
"ok": true
}
}