Suspend a subscriber

POST /api/v1/users/{id}/suspend prm_users_enable_disable

Sets enabled to false and, when the tenant has disconnect-on-update enabled, kicks any live session so the suspension takes effect now rather than at the next re-auth.

نظرة سريعة

المصادقة: رمز موظّف أو جلسة
تتطلب صلاحية: prm_users_enable_disable Enable / suspend users
حد المعدل: t_mutate

المعاملات

المعامل	الوصف
`id`مطلوب path · integer	Subscriber id.

الأخطاء

الرمز	متى تُرجَع
`ERR_NOT_FOUND`404	no such subscriber, or one outside the caller's subtree

الطلب

curl -X POST "$BASE/api/v1/users/{id}/suspend" \
  -H "Authorization: Bearer $XR_TOKEN"

الاستجابة 200 OK

{
  "data": {
    "id": 4711,
    "username": "ahmed",
    "enabled": false,
    "status": { "enabled": false, "can_connect": false }
  }
}

‏BASE هو عنوان مؤسستك: نفس العنوان الذي تسجّل الدخول منه.

جرّبه على شبكتك.

50 مشترك لمدة 7 أيام، من غير ما تدفع حاجة.

جرّب ببلاش كلّمنا