مرجع API

اعضای سازمان

عضویت به کاربر اجازهٔ ورود به سازمان را می‌دهد. نقش کاربر و تنظیمات دسترسی پروژه تعیین می‌کنند چه کارهای مدیریتی‌ای برایش مجاز است.

روند کار

01تغییر نقش یا تیم پیش‌فرض عضو
02حذف یا تعلیق عضو سازمان
03فهرست اعضای سازمان

روی هر عملیات بزنید تا همهٔ ورودی‌ها، request، response و کدهای وضعیت آن را ببینید.

تغییر نقش یا تیم پیش‌فرض عضو

PATCH/api/v1/tenancy/members/{membership_id}

آدرس پایهٔ APIhttps://api.mahvashai.ir

احراز هویتJWT کاربر

Responseresponse در قالب مخصوص مهوش

نوع محتواapplication/json

پارامترها

این جدول همهٔ ورودی‌هایی را که این endpoint می‌پذیرد نشان می‌دهد. مقدارهای نمونه‌ها ساختگی‌اند و یک روش امن برای یکپارچه‌سازی را نشان می‌دهند.

نام	محل ارسال	نوع	الزامی	پشتیبانی	توضیحات
`membership_id`	مسیر (path)	string	الزامی	مخصوص مهوش	شناسهٔ عضویت.
`X-Request-ID`	Header	string	اختیاری	مخصوص مهوش	شناسهٔ ردگیری که کلاینت می‌فرستد. در همهٔ پاسخ‌ها برمی‌گردد و اگر فرستاده نشود یا قالبش درست نباشد، سرور شناسهٔ تازه‌ای می‌سازد.
`X-Mahvash-Project`	Header	string	اختیاری	مخصوص مهوش	slug یا شناسهٔ پروژه در سازمان شما. دامنهٔ request را محدودتر می‌کند و هرگز دسترسی بیشتری نمی‌دهد.
`default_team`	Body	string	اختیاری	مخصوص مهوش	تیمی که اگر چیز دیگری مشخص نشده باشد، مصرف این عضو به حسابش نوشته می‌شود. عضو باید در همان تیم باشد و `null` آن را پاک می‌کند. فقط برای گزارش مصرف است و دسترسی نمی‌دهد.
`role`	Body	string	اختیاری	مخصوص مهوش	نقش در سازمان: `owner`، `admin`، `member` یا `viewer`؛ نمی‌تواند بالاتر از نقش خود شما باشد.

Request

curl -X PATCH 'https://api.mahvashai.ir/api/v1/tenancy/members/<membership_id>' \
  -H "Authorization: Bearer $MAHVASH_USER_JWT" \
  -H "Content-Type: application/json" \
  -d '{
  "default_team": "8f14e45f-ceea-467a-9d4a-1f2b3c4d5e6f"
}'

Response

{
  "status": 0,
  "data": "<value>"
}

این نمونه فقط ساختار response را نشان می‌دهد؛ فیلدهای واقعی به نوع عملیات و مدل بستگی دارند.

کدهای وضعیت

HTTP	توضیحات
200	request با موفقیت انجام شد.
400	request نامعتبر است.
401	اطلاعات احراز هویت فرستاده نشده یا معتبر نیست.
403	دسترسی لازم را ندارید.
404	منبع پیدا نشد یا برای شما قابل دسترسی نیست.
429	از سقف مجاز عبور کرده‌اید.
500	خطای داخلی سرور.

حذف یا تعلیق عضو سازمان

DELETE/api/v1/tenancy/members/{membership_id}

آدرس پایهٔ APIhttps://api.mahvashai.ir

احراز هویتJWT کاربر

Responseresponse در قالب مخصوص مهوش

پارامترها

نام	محل ارسال	نوع	الزامی	پشتیبانی	توضیحات
`membership_id`	مسیر (path)	string	الزامی	مخصوص مهوش	شناسهٔ عضویت.
`X-Request-ID`	Header	string	اختیاری	مخصوص مهوش	شناسهٔ ردگیری که کلاینت می‌فرستد. در همهٔ پاسخ‌ها برمی‌گردد و اگر فرستاده نشود یا قالبش درست نباشد، سرور شناسهٔ تازه‌ای می‌سازد.
`X-Mahvash-Project`	Header	string	اختیاری	مخصوص مهوش	slug یا شناسهٔ پروژه در سازمان شما. دامنهٔ request را محدودتر می‌کند و هرگز دسترسی بیشتری نمی‌دهد.

Request

curl -X DELETE 'https://api.mahvashai.ir/api/v1/tenancy/members/<membership_id>' \
  -H "Authorization: Bearer $MAHVASH_USER_JWT"

Response

{
  "status": 0,
  "data": "<value>"
}

این نمونه فقط ساختار response را نشان می‌دهد؛ فیلدهای واقعی به نوع عملیات و مدل بستگی دارند.

کدهای وضعیت

HTTP	توضیحات
200	request با موفقیت انجام شد.
400	request نامعتبر است.
401	اطلاعات احراز هویت فرستاده نشده یا معتبر نیست.
403	دسترسی لازم را ندارید.
404	منبع پیدا نشد یا برای شما قابل دسترسی نیست.
429	از سقف مجاز عبور کرده‌اید.
500	خطای داخلی سرور.

فهرست اعضای سازمان

GET/api/v1/tenancy/members

آدرس پایهٔ APIhttps://api.mahvashai.ir

احراز هویتJWT کاربر

Responseresponse در قالب مخصوص مهوش

پارامترها

نام	محل ارسال	نوع	الزامی	پشتیبانی	توضیحات
`page`	Query	integer	اختیاری	مخصوص مهوش	شمارهٔ صفحه در فهرست.
`page_size`	Query	integer	اختیاری	مخصوص مهوش	تعداد موارد هر صفحه در فهرست.
`role`	Query	string	اختیاری	مخصوص مهوش	فیلتر فهرست بر اساس نقش.
`search`	Query	string	اختیاری	مخصوص مهوش	عبارت جست‌وجو در فهرست.
`status`	Query	string	اختیاری	مخصوص مهوش	فیلتر فهرست بر اساس وضعیت.
`X-Request-ID`	Header	string	اختیاری	مخصوص مهوش	شناسهٔ ردگیری که کلاینت می‌فرستد. در همهٔ پاسخ‌ها برمی‌گردد و اگر فرستاده نشود یا قالبش درست نباشد، سرور شناسهٔ تازه‌ای می‌سازد.
`X-Mahvash-Project`	Header	string	اختیاری	مخصوص مهوش	slug یا شناسهٔ پروژه در سازمان شما. دامنهٔ request را محدودتر می‌کند و هرگز دسترسی بیشتری نمی‌دهد.

Request

curl -X GET 'https://api.mahvashai.ir/api/v1/tenancy/members' \
  -H "Authorization: Bearer $MAHVASH_USER_JWT"

Response

{
  "status": 0,
  "data": "<value>"
}

این نمونه فقط ساختار response را نشان می‌دهد؛ فیلدهای واقعی به نوع عملیات و مدل بستگی دارند.

کدهای وضعیت

HTTP	توضیحات
200	request با موفقیت انجام شد.
401	اطلاعات احراز هویت فرستاده نشده یا معتبر نیست.
403	دسترسی لازم را ندارید.
404	منبع پیدا نشد یا برای شما قابل دسترسی نیست.
429	از سقف مجاز عبور کرده‌اید.
500	خطای داخلی سرور.