API reference

Access groups

GET/v1/team/groups

The team's access groups#

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

Credential: An API key or a dashboard session
Roles: admin

Response

200object

groupsAccessGroup[]required
- idstring (uuid)
- namestring
- membersinteger
- accessinteger
- created_atstring (date-time)

Errors

Status	Description
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

Example

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.

Credential: An API key or a dashboard session
Roles: admin
Step-up: With a dashboard session, a second factor confirmed in the last 10 minutes; API keys pass.

Request body`application/json`

namestringrequired
1–60 characters

Response

201AccessGroupCreated

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

Errors

Status	Description
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

Example

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.

Credential: An API key or a dashboard session
Roles: admin

Parameters

idstring (uuid)pathrequired
the group's id

Response

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

Errors

Status	Description
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

Example

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.

Credential: An API key or a dashboard session
Roles: admin
Step-up: With a dashboard session, a second factor confirmed in the last 10 minutes; API keys pass.

Parameters

idstring (uuid)pathrequired
the group's id

Response

200object

deletedstring

Errors

Status	Description
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

Example

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.

Credential: An API key or a dashboard session
Roles: admin
Step-up: With a dashboard session, a second factor confirmed in the last 10 minutes; API keys pass.

Parameters

idstring (uuid)pathrequired
the group's id

Request body`application/json`

namestringrequired
1–60 characters

Response

200object

idstring
namestring

Errors

Status	Description
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

Example

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.

Credential: An API key or a dashboard session
Roles: admin
Step-up: With a dashboard session, a second factor confirmed in the last 10 minutes; API keys pass.

Parameters

idstring (uuid)pathrequired
the group's id
personstring (uuid)pathrequired
the person's id

Response

200object

groupstring
personstring

Errors

Status	Description
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

Example

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.

Credential: An API key or a dashboard session
Roles: admin
Step-up: With a dashboard session, a second factor confirmed in the last 10 minutes; API keys pass.

Parameters

idstring (uuid)pathrequired
the group's id
personstring (uuid)pathrequired
the person's id

Response

200object

groupstring
removedstring

Errors

Status	Description
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

Example

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.

Credential: An API key or a dashboard session
Roles: admin
Step-up: With a dashboard session, a second factor confirmed in the last 10 minutes; API keys pass.

Parameters

idstring (uuid)pathrequired
the group's id
kindstringpathrequired
function, app, database, cache or bucket
one of function, app, database, cache, bucket
namestringpathrequired
the project's or store's name

Request body`application/json`

rolestring
one of developer, viewer · default "developer"

Response

200object

Errors

Status	Description
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

Example

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.

Credential: An API key or a dashboard session
Roles: admin
Step-up: With a dashboard session, a second factor confirmed in the last 10 minutes; API keys pass.

Parameters

idstring (uuid)pathrequired
the group's id
kindstringpathrequired
function, app, database, cache or bucket
one of function, app, database, cache, bucket
namestringpathrequired
the project's or store's name

Response

200object

Errors

Status	Description
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

Example

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#

Credential: An API key or a dashboard session
Roles: admin

Parameters

personstring (uuid)pathrequired
the person's id

Response

200object

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

Errors

Status	Description
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

Example

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.

Credential: An API key or a dashboard session
Roles: admin
Step-up: With a dashboard session, a second factor confirmed in the last 10 minutes; API keys pass.

Parameters

personstring (uuid)pathrequired
the person's id
kindstringpathrequired
function, app, database, cache or bucket
one of function, app, database, cache, bucket
namestringpathrequired
the project's or store's name

Request body`application/json`

rolestring
one of developer, viewer · default "developer"

Response

200object

Errors

Status	Description
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

Example

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.

Credential: An API key or a dashboard session
Roles: admin
Step-up: With a dashboard session, a second factor confirmed in the last 10 minutes; API keys pass.

Parameters

personstring (uuid)pathrequired
the person's id
kindstringpathrequired
function, app, database, cache or bucket
one of function, app, database, cache, bucket
namestringpathrequired
the project's or store's name

Response

200object

Errors

Status	Description
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

Example

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.

Credential: An API key or a dashboard session
Roles: Any role

Parameters

namestringpathrequired

Response

200object

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

Errors

Status	Description
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

Example

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.

Credential: An API key or a dashboard session
Roles: Any role

Parameters

namestringpathrequired

Response

200object

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

Errors

Status	Description
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

Example

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.

Credential: An API key or a dashboard session
Roles: Any role

Parameters

namestringpathrequired

Response

200object

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

Errors

Status	Description
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

Example

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.

Credential: An API key or a dashboard session
Roles: Any role

Parameters

namestringpathrequired

Response

200object

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

Errors

Status	Description
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

Example

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.

Credential: An API key or a dashboard session
Roles: Any role

Parameters

namestringpathrequired

Response

200object

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

Errors

Status	Description
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

Example

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

The team's access groups#

Response

Errors

Example

Make an access group#

Request bodyapplication/json

Response

Errors

Example

One access group#

Parameters

Response

Errors

Example

Delete an access group#

Parameters

Response

Errors

Example

Rename an access group#

Parameters

Request bodyapplication/json

Response

Errors

Example

Put a member in a group#

Parameters

Response

Errors

Example

Take a member out of a group#

Parameters

Response

Errors

Example

Give a group a role on a project or store#

Parameters

Request bodyapplication/json

Response

Errors

Example

Take a group's access away#

Parameters

Response

Errors

Example

One member's own grants and groups#

Parameters

Response

Errors

Example

Give a member a role on a project or store#

Parameters

Request bodyapplication/json

Response

Errors

Example

Take a member's own access away#

Parameters

Response

Errors

Example

Who has access to a function#

Parameters

Response

Errors

Example

Who has access to a app#

Parameters

Response

Errors

Example

Who has access to a database#

Parameters

Response

Errors

Example

Who has access to a cache#

Parameters

Response

Request body`application/json`

Request body`application/json`

Request body`application/json`

Request body`application/json`