مرجع API
دسترسی به پروژه (grantها)
grant یک کاربر یا تیم را به پروژهٔ محدود (restricted) وصل می‌کند؛ البته اگر این قابلیت در سرویس فعال باشد. پیش از طراحی روند مبتنی بر grant، از فعال بودن آن مطمئن شوید.
روند کار
روی هر عملیات بزنید تا همهٔ ورودی‌ها، request، response و کدهای وضعیت آن را ببینید.
دادن دسترسی پروژه به یک تیم یا عضو
/api/v1/tenancy/projects/{project_id}/grantshttps://api.mahvashai.irapplication/jsonپارامترها
این جدول همهٔ ورودی‌هایی را که این endpoint می‌پذیرد نشان می‌دهد. مقدارهای نمونه‌ها ساختگی‌اند و یک روش امن برای یکپارچه‌سازی را نشان می‌دهند.
| نام | محل ارسال | نوع | الزامی | پشتیبانی | توضیحات |
|---|---|---|---|---|---|
project_id | مسیر (path) | string | الزامی | مخصوص مهوش | شناسهٔ پروژه. |
X-Request-ID | Header | string | اختیاری | مخصوص مهوش | شناسهٔ ردگیری که کلاینت می‌فرستد. در همهٔ پاسخ‌ها برمی‌گردد و اگر فرستاده نشود یا قالبش درست نباشد، سرور شناسهٔ تازه‌ای می‌سازد. |
X-Mahvash-Project | Header | string | اختیاری | مخصوص مهوش | slug یا شناسهٔ پروژه در سازمان شما. دامنهٔ request را محدودتر می‌کند و هرگز دسترسی بیشتری نمی‌دهد. |
membership | Body | string | اختیاری | مخصوص مهوش | شناسهٔ عضویتی که دسترسی می‌گیرد. دقیقاً یکی از team یا membership را بفرستید. |
role | Body | string | اختیاری | مخصوص مهوش | نقشی که این grant می‌دهد. نقش نهایی هرگز از نقش سازمانی فرد بالاتر نمی‌رود. |
team | Body | string | اختیاری | مخصوص مهوش | شناسهٔ تیمی که دسترسی می‌گیرد. دقیقاً یکی از team یا membership را بفرستید. |
Request
curl -X POST 'https://api.mahvashai.ir/api/v1/tenancy/projects/<project_id>/grants' \
-H "Authorization: Bearer $MAHVASH_USER_JWT" \
-H "Content-Type: application/json" \
-d '{
"membership": "8f14e45f-ceea-467a-9d4a-1f2b3c4d5e6f"
}'Response
{
"status": 0,
"data": "<value>"
}این نمونه فقط ساختار response را نشان می‌دهد؛ فیلدهای واقعی به نوع عملیات و مدل بستگی دارند.
کدهای وضعیت
| HTTP | توضیحات |
|---|---|
| 201 | منبع ساخته شد. |
| 400 | request نامعتبر است. |
| 401 | اطلاعات احراز هویت فرستاده نشده یا معتبر نیست. |
| 403 | دسترسی لازم را ندارید. |
| 404 | منبع پیدا نشد یا برای شما قابل دسترسی نیست. |
| 429 | از سقف مجاز عبور کرده‌اید. |
| 500 | خطای داخلی سرور. |
لغو دسترسی پروژه
/api/v1/tenancy/projects/{project_id}/grants/{grant_id}https://api.mahvashai.irپارامترها
این جدول همهٔ ورودی‌هایی را که این endpoint می‌پذیرد نشان می‌دهد. مقدارهای نمونه‌ها ساختگی‌اند و یک روش امن برای یکپارچه‌سازی را نشان می‌دهند.
| نام | محل ارسال | نوع | الزامی | پشتیبانی | توضیحات |
|---|---|---|---|---|---|
project_id | مسیر (path) | string | الزامی | مخصوص مهوش | شناسهٔ پروژه. |
grant_id | مسیر (path) | string | الزامی | مخصوص مهوش | شناسهٔ grant. |
X-Request-ID | Header | string | اختیاری | مخصوص مهوش | شناسهٔ ردگیری که کلاینت می‌فرستد. در همهٔ پاسخ‌ها برمی‌گردد و اگر فرستاده نشود یا قالبش درست نباشد، سرور شناسهٔ تازه‌ای می‌سازد. |
X-Mahvash-Project | Header | string | اختیاری | مخصوص مهوش | slug یا شناسهٔ پروژه در سازمان شما. دامنهٔ request را محدودتر می‌کند و هرگز دسترسی بیشتری نمی‌دهد. |
Request
curl -X DELETE 'https://api.mahvashai.ir/api/v1/tenancy/projects/<project_id>/grants/<grant_id>' \
-H "Authorization: Bearer $MAHVASH_USER_JWT"Response
{
"status": 0,
"data": "<value>"
}این نمونه فقط ساختار response را نشان می‌دهد؛ فیلدهای واقعی به نوع عملیات و مدل بستگی دارند.
کدهای وضعیت
| HTTP | توضیحات |
|---|---|
| 200 | request با موفقیت انجام شد. |
| 400 | request نامعتبر است. |
| 401 | اطلاعات احراز هویت فرستاده نشده یا معتبر نیست. |
| 403 | دسترسی لازم را ندارید. |
| 404 | منبع پیدا نشد یا برای شما قابل دسترسی نیست. |
| 429 | از سقف مجاز عبور کرده‌اید. |
| 500 | خطای داخلی سرور. |
فهرست دسترسی‌های پروژه
/api/v1/tenancy/projects/{project_id}/grantshttps://api.mahvashai.irپارامترها
این جدول همهٔ ورودی‌هایی را که این endpoint می‌پذیرد نشان می‌دهد. مقدارهای نمونه‌ها ساختگی‌اند و یک روش امن برای یکپارچه‌سازی را نشان می‌دهند.
| نام | محل ارسال | نوع | الزامی | پشتیبانی | توضیحات |
|---|---|---|---|---|---|
project_id | مسیر (path) | string | الزامی | مخصوص مهوش | شناسهٔ پروژه. |
X-Request-ID | Header | string | اختیاری | مخصوص مهوش | شناسهٔ ردگیری که کلاینت می‌فرستد. در همهٔ پاسخ‌ها برمی‌گردد و اگر فرستاده نشود یا قالبش درست نباشد، سرور شناسهٔ تازه‌ای می‌سازد. |
X-Mahvash-Project | Header | string | اختیاری | مخصوص مهوش | slug یا شناسهٔ پروژه در سازمان شما. دامنهٔ request را محدودتر می‌کند و هرگز دسترسی بیشتری نمی‌دهد. |
Request
curl -X GET 'https://api.mahvashai.ir/api/v1/tenancy/projects/<project_id>/grants' \
-H "Authorization: Bearer $MAHVASH_USER_JWT"Response
{
"status": 0,
"data": "<value>"
}این نمونه فقط ساختار response را نشان می‌دهد؛ فیلدهای واقعی به نوع عملیات و مدل بستگی دارند.
کدهای وضعیت
| HTTP | توضیحات |
|---|---|
| 200 | request با موفقیت انجام شد. |
| 401 | اطلاعات احراز هویت فرستاده نشده یا معتبر نیست. |
| 403 | دسترسی لازم را ندارید. |
| 404 | منبع پیدا نشد یا برای شما قابل دسترسی نیست. |
| 429 | از سقف مجاز عبور کرده‌اید. |
| 500 | خطای داخلی سرور. |