مرجع API

گروه‌های دسترسی

محدود کردن اعضا به پروژه‌های برگزیده و نقش دادن با گروه.

توضیح هر مسیر به انگلیسی است، همان متنی که مرجع از کد ساخته می‌شود. مسیرها، نام فیلدها و کدها همان‌اند که در درخواست می‌نویسید.

GET/v1/team/groups

The team's access groups#

A limited member (see Access groups) is refused with 403.

دسترسی: کلید API یا نشست داشبورد
نقش‌ها: ادمین

پاسخ

200object

groupsAccessGroup[]الزامی
- idstring (uuid)
- namestring
- membersinteger
- accessinteger
- created_atstring (date-time)

خطاها

وضعیت	توضیح
401	`unauthorized`: missing, invalid, expired or revoked credential
403	Forbidden: `forbidden`, or `step_up_required`
404	Not found: `not_found`
500	`internal`: an unexpected failure

نمونه

curl "https://api.ibel.ai/v1/team/groups" \
  -H "Authorization: Bearer $KEY"

POST/v1/team/groups

Make an access group#

Names are unique in a team whatever their case; at most 100 groups. Needs step-up with a session.

دسترسی: کلید API یا نشست داشبورد
نقش‌ها: ادمین
تایید دوم: با نشست داشبورد، عامل دوم در ۱۰ دقیقهٔ اخیر لازم است؛ کلید API نیازی ندارد.

بدنهٔ درخواست`application/json`

namestringالزامی
1–60 characters

پاسخ

201AccessGroupCreated

idstring (uuid)
namestring
membersinteger
accessinteger
created_atstring (date-time)

خطاها

وضعیت	توضیح
401	`unauthorized`: missing, invalid, expired or revoked credential
403	Forbidden: `forbidden`, or `step_up_required`
404	Not found: `not_found`
500	`internal`: an unexpected failure

نمونه

curl -X POST "https://api.ibel.ai/v1/team/groups" \
  -H "Authorization: Bearer $KEY" \
  -d '{"name":"Frontend"}'

GET/v1/team/groups/{id}

One access group#

Its members and what it gives.

دسترسی: کلید API یا نشست داشبورد
نقش‌ها: ادمین

پارامترها

idstring (uuid)مسیرالزامی
the group's id

پاسخ

200object

idstring (uuid)
namestring
created_atstring (date-time)
membersobject[]
- idstring (uuid)
- emailstring
- rolestring
- restrictedboolean
accessAccessGrant[]
- kindstring
  one of function, app, database, cache, bucket
- namestring
- rolestring
  one of developer, viewer

خطاها

وضعیت	توضیح
401	`unauthorized`: missing, invalid, expired or revoked credential
403	Forbidden: `forbidden`, or `step_up_required`
404	Not found: `not_found`
500	`internal`: an unexpected failure

نمونه

curl "https://api.ibel.ai/v1/team/groups/88e2fe1d-6d75-4de5-8c8f-27380ec66903" \
  -H "Authorization: Bearer $KEY"

DELETE/v1/team/groups/{id}

Delete an access group#

Its members lose the access only it gave them. Needs step-up with a session.

دسترسی: کلید API یا نشست داشبورد
نقش‌ها: ادمین
تایید دوم: با نشست داشبورد، عامل دوم در ۱۰ دقیقهٔ اخیر لازم است؛ کلید API نیازی ندارد.

پارامترها

idstring (uuid)مسیرالزامی
the group's id

پاسخ

200object

deletedstring

خطاها

وضعیت	توضیح
401	`unauthorized`: missing, invalid, expired or revoked credential
403	Forbidden: `forbidden`, or `step_up_required`
404	Not found: `not_found`
500	`internal`: an unexpected failure

نمونه

curl -X DELETE "https://api.ibel.ai/v1/team/groups/88e2fe1d-6d75-4de5-8c8f-27380ec66903" \
  -H "Authorization: Bearer $KEY"

PATCH/v1/team/groups/{id}

Rename an access group#

Needs step-up with a session.

دسترسی: کلید API یا نشست داشبورد
نقش‌ها: ادمین
تایید دوم: با نشست داشبورد، عامل دوم در ۱۰ دقیقهٔ اخیر لازم است؛ کلید API نیازی ندارد.

پارامترها

idstring (uuid)مسیرالزامی
the group's id

بدنهٔ درخواست`application/json`

namestringالزامی
1–60 characters

پاسخ

200object

idstring
namestring

خطاها

وضعیت	توضیح
401	`unauthorized`: missing, invalid, expired or revoked credential
403	Forbidden: `forbidden`, or `step_up_required`
404	Not found: `not_found`
500	`internal`: an unexpected failure

نمونه

curl -X PATCH "https://api.ibel.ai/v1/team/groups/88e2fe1d-6d75-4de5-8c8f-27380ec66903" \
  -H "Authorization: Bearer $KEY" \
  -d '{"name":"Frontend"}'

PUT/v1/team/groups/{id}/members/{person}

Put a member in a group#

Needs step-up with a session.

دسترسی: کلید API یا نشست داشبورد
نقش‌ها: ادمین
تایید دوم: با نشست داشبورد، عامل دوم در ۱۰ دقیقهٔ اخیر لازم است؛ کلید API نیازی ندارد.

پارامترها

idstring (uuid)مسیرالزامی
the group's id
personstring (uuid)مسیرالزامی
the person's id

پاسخ

200object

groupstring
personstring

خطاها

وضعیت	توضیح
401	`unauthorized`: missing, invalid, expired or revoked credential
403	Forbidden: `forbidden`, or `step_up_required`
404	Not found: `not_found`
500	`internal`: an unexpected failure

نمونه

curl -X PUT "https://api.ibel.ai/v1/team/groups/88e2fe1d-6d75-4de5-8c8f-27380ec66903/members/5b0f4c2e-8f1d-4a7e-9c3b-2d6e1f0a9b8c" \
  -H "Authorization: Bearer $KEY"

DELETE/v1/team/groups/{id}/members/{person}

Take a member out of a group#

Needs step-up with a session.

دسترسی: کلید API یا نشست داشبورد
نقش‌ها: ادمین
تایید دوم: با نشست داشبورد، عامل دوم در ۱۰ دقیقهٔ اخیر لازم است؛ کلید API نیازی ندارد.

پارامترها

idstring (uuid)مسیرالزامی
the group's id
personstring (uuid)مسیرالزامی
the person's id

پاسخ

200object

groupstring
removedstring

خطاها

وضعیت	توضیح
401	`unauthorized`: missing, invalid, expired or revoked credential
403	Forbidden: `forbidden`, or `step_up_required`
404	Not found: `not_found`
500	`internal`: an unexpected failure

نمونه

curl -X DELETE "https://api.ibel.ai/v1/team/groups/88e2fe1d-6d75-4de5-8c8f-27380ec66903/members/5b0f4c2e-8f1d-4a7e-9c3b-2d6e1f0a9b8c" \
  -H "Authorization: Bearer $KEY"

PUT/v1/team/groups/{id}/access/{kind}/{name}

Give a group a role on a project or store#

Developer (may change it) or viewer (reads only). Needs step-up with a session.

دسترسی: کلید API یا نشست داشبورد
نقش‌ها: ادمین
تایید دوم: با نشست داشبورد، عامل دوم در ۱۰ دقیقهٔ اخیر لازم است؛ کلید API نیازی ندارد.

پارامترها

idstring (uuid)مسیرالزامی
the group's id
kindstringمسیرالزامی
function, app, database, cache or bucket
one of function, app, database, cache, bucket
namestringمسیرالزامی
the project's or store's name

بدنهٔ درخواست`application/json`

rolestring
one of developer, viewer · default "developer"

پاسخ

200object

خطاها

وضعیت	توضیح
401	`unauthorized`: missing, invalid, expired or revoked credential
403	Forbidden: `forbidden`, or `step_up_required`
404	Not found: `not_found`
500	`internal`: an unexpected failure

نمونه

curl -X PUT "https://api.ibel.ai/v1/team/groups/88e2fe1d-6d75-4de5-8c8f-27380ec66903/access/kind/Frontend" \
  -H "Authorization: Bearer $KEY" \
  -d '{"role":"developer"}'

DELETE/v1/team/groups/{id}/access/{kind}/{name}

Take a group's access away#

Needs step-up with a session.

دسترسی: کلید API یا نشست داشبورد
نقش‌ها: ادمین
تایید دوم: با نشست داشبورد، عامل دوم در ۱۰ دقیقهٔ اخیر لازم است؛ کلید API نیازی ندارد.

پارامترها

idstring (uuid)مسیرالزامی
the group's id
kindstringمسیرالزامی
function, app, database, cache or bucket
one of function, app, database, cache, bucket
namestringمسیرالزامی
the project's or store's name

پاسخ

200object

خطاها

وضعیت	توضیح
401	`unauthorized`: missing, invalid, expired or revoked credential
403	Forbidden: `forbidden`, or `step_up_required`
404	Not found: `not_found`
500	`internal`: an unexpected failure

نمونه

curl -X DELETE "https://api.ibel.ai/v1/team/groups/88e2fe1d-6d75-4de5-8c8f-27380ec66903/access/kind/Frontend" \
  -H "Authorization: Bearer $KEY"

GET/v1/team/members/{person}/access

One member's own grants and groups#

دسترسی: کلید API یا نشست داشبورد
نقش‌ها: ادمین

پارامترها

personstring (uuid)مسیرالزامی
the person's id

پاسخ

200object

personstring
emailstring
rolestring
restrictedboolean
accessAccessGrant[]
- kindstring
  one of function, app, database, cache, bucket
- namestring
- rolestring
  one of developer, viewer
groupsobject[]
- idstring
- namestring

خطاها

وضعیت	توضیح
401	`unauthorized`: missing, invalid, expired or revoked credential
403	Forbidden: `forbidden`, or `step_up_required`
404	Not found: `not_found`
500	`internal`: an unexpected failure

نمونه

curl "https://api.ibel.ai/v1/team/members/5b0f4c2e-8f1d-4a7e-9c3b-2d6e1f0a9b8c/access" \
  -H "Authorization: Bearer $KEY"

PUT/v1/team/members/{person}/access/{kind}/{name}

Give a member a role on a project or store#

Counts only while the member is limited. Needs step-up with a session.

دسترسی: کلید API یا نشست داشبورد
نقش‌ها: ادمین
تایید دوم: با نشست داشبورد، عامل دوم در ۱۰ دقیقهٔ اخیر لازم است؛ کلید API نیازی ندارد.

پارامترها

personstring (uuid)مسیرالزامی
the person's id
kindstringمسیرالزامی
function, app, database, cache or bucket
one of function, app, database, cache, bucket
namestringمسیرالزامی
the project's or store's name

بدنهٔ درخواست`application/json`

rolestring
one of developer, viewer · default "developer"

پاسخ

200object

خطاها

وضعیت	توضیح
401	`unauthorized`: missing, invalid, expired or revoked credential
403	Forbidden: `forbidden`, or `step_up_required`
404	Not found: `not_found`
500	`internal`: an unexpected failure

نمونه

curl -X PUT "https://api.ibel.ai/v1/team/members/5b0f4c2e-8f1d-4a7e-9c3b-2d6e1f0a9b8c/access/kind/Frontend" \
  -H "Authorization: Bearer $KEY" \
  -d '{"role":"developer"}'

DELETE/v1/team/members/{person}/access/{kind}/{name}

Take a member's own access away#

Needs step-up with a session.

دسترسی: کلید API یا نشست داشبورد
نقش‌ها: ادمین
تایید دوم: با نشست داشبورد، عامل دوم در ۱۰ دقیقهٔ اخیر لازم است؛ کلید API نیازی ندارد.

پارامترها

personstring (uuid)مسیرالزامی
the person's id
kindstringمسیرالزامی
function, app, database, cache or bucket
one of function, app, database, cache, bucket
namestringمسیرالزامی
the project's or store's name

پاسخ

200object

خطاها

وضعیت	توضیح
401	`unauthorized`: missing, invalid, expired or revoked credential
403	Forbidden: `forbidden`, or `step_up_required`
404	Not found: `not_found`
500	`internal`: an unexpected failure

نمونه

curl -X DELETE "https://api.ibel.ai/v1/team/members/5b0f4c2e-8f1d-4a7e-9c3b-2d6e1f0a9b8c/access/kind/Frontend" \
  -H "Authorization: Bearer $KEY"

GET/v1/functions/{name}/members

Who has access to a function#

The members who are not limited, and the limited members with their role and where it comes from. A limited member needs a grant on it.

دسترسی: کلید API یا نشست داشبورد
نقش‌ها: همهٔ نقش‌ها

پارامترها

namestringمسیرالزامی

پاسخ

200object

resourceobject
- kindstring
  one of function, app, database, cache, bucket
- namestring
teamobject[]
- idstring
- emailstring
- rolestring
limitedobject[]
- idstring
- emailstring
- rolestring
- viaobject[]

خطاها

وضعیت	توضیح
401	`unauthorized`: missing, invalid, expired or revoked credential
403	Forbidden: `forbidden`, or `step_up_required`
404	Not found: `not_found`
500	`internal`: an unexpected failure

نمونه

curl "https://api.ibel.ai/v1/functions/Frontend/members" \
  -H "Authorization: Bearer $KEY"

GET/v1/apps/{name}/members

Who has access to a app#

The members who are not limited, and the limited members with their role and where it comes from. A limited member needs a grant on it.

دسترسی: کلید API یا نشست داشبورد
نقش‌ها: همهٔ نقش‌ها

پارامترها

namestringمسیرالزامی

پاسخ

200object

resourceobject
- kindstring
  one of function, app, database, cache, bucket
- namestring
teamobject[]
- idstring
- emailstring
- rolestring
limitedobject[]
- idstring
- emailstring
- rolestring
- viaobject[]

خطاها

وضعیت	توضیح
401	`unauthorized`: missing, invalid, expired or revoked credential
403	Forbidden: `forbidden`, or `step_up_required`
404	Not found: `not_found`
500	`internal`: an unexpected failure

نمونه

curl "https://api.ibel.ai/v1/apps/Frontend/members" \
  -H "Authorization: Bearer $KEY"

GET/v1/db/projects/{name}/members

Who has access to a database#

The members who are not limited, and the limited members with their role and where it comes from. A limited member needs a grant on it.

دسترسی: کلید API یا نشست داشبورد
نقش‌ها: همهٔ نقش‌ها

پارامترها

namestringمسیرالزامی

پاسخ

200object

resourceobject
- kindstring
  one of function, app, database, cache, bucket
- namestring
teamobject[]
- idstring
- emailstring
- rolestring
limitedobject[]
- idstring
- emailstring
- rolestring
- viaobject[]

خطاها

وضعیت	توضیح
401	`unauthorized`: missing, invalid, expired or revoked credential
403	Forbidden: `forbidden`, or `step_up_required`
404	Not found: `not_found`
500	`internal`: an unexpected failure

نمونه

curl "https://api.ibel.ai/v1/db/projects/Frontend/members" \
  -H "Authorization: Bearer $KEY"

GET/v1/cache/databases/{name}/members

Who has access to a cache#

The members who are not limited, and the limited members with their role and where it comes from. A limited member needs a grant on it.

دسترسی: کلید API یا نشست داشبورد
نقش‌ها: همهٔ نقش‌ها

پارامترها

namestringمسیرالزامی

پاسخ

200object

resourceobject
- kindstring
  one of function, app, database, cache, bucket
- namestring
teamobject[]
- idstring
- emailstring
- rolestring
limitedobject[]
- idstring
- emailstring
- rolestring
- viaobject[]

خطاها

وضعیت	توضیح
401	`unauthorized`: missing, invalid, expired or revoked credential
403	Forbidden: `forbidden`, or `step_up_required`
404	Not found: `not_found`
500	`internal`: an unexpected failure

نمونه

curl "https://api.ibel.ai/v1/cache/databases/Frontend/members" \
  -H "Authorization: Bearer $KEY"

GET/v1/buckets/{name}/members

Who has access to a bucket#

The members who are not limited, and the limited members with their role and where it comes from. A limited member needs a grant on it.

دسترسی: کلید API یا نشست داشبورد
نقش‌ها: همهٔ نقش‌ها

پارامترها

namestringمسیرالزامی

پاسخ

200object

resourceobject
- kindstring
  one of function, app, database, cache, bucket
- namestring
teamobject[]
- idstring
- emailstring
- rolestring
limitedobject[]
- idstring
- emailstring
- rolestring
- viaobject[]

خطاها

وضعیت	توضیح
401	`unauthorized`: missing, invalid, expired or revoked credential
403	Forbidden: `forbidden`, or `step_up_required`
404	Not found: `not_found`
500	`internal`: an unexpected failure

نمونه

curl "https://api.ibel.ai/v1/buckets/Frontend/members" \
  -H "Authorization: Bearer $KEY"

The team's access groups#

پاسخ

خطاها

نمونه

Make an access group#

بدنهٔ درخواستapplication/json

پاسخ

خطاها

نمونه

One access group#

پارامترها

پاسخ

خطاها

نمونه

Delete an access group#

پارامترها

پاسخ

خطاها

نمونه

Rename an access group#

پارامترها

بدنهٔ درخواستapplication/json

پاسخ

خطاها

نمونه

Put a member in a group#

پارامترها

پاسخ

خطاها

نمونه

Take a member out of a group#

پارامترها

پاسخ

خطاها

نمونه

Give a group a role on a project or store#

پارامترها

بدنهٔ درخواستapplication/json

پاسخ

خطاها

نمونه

Take a group's access away#

پارامترها

پاسخ

خطاها

نمونه

One member's own grants and groups#

پارامترها

پاسخ

خطاها

نمونه

Give a member a role on a project or store#

پارامترها

بدنهٔ درخواستapplication/json

پاسخ

خطاها

نمونه

Take a member's own access away#

پارامترها

پاسخ

خطاها

نمونه

Who has access to a function#

پارامترها

پاسخ

خطاها

نمونه

Who has access to a app#

پارامترها

پاسخ

خطاها

نمونه

Who has access to a database#

پارامترها

پاسخ

خطاها

نمونه

Who has access to a cache#

پارامترها

پاسخ

بدنهٔ درخواست`application/json`

بدنهٔ درخواست`application/json`

بدنهٔ درخواست`application/json`

بدنهٔ درخواست`application/json`