Skip to content

Commit

Permalink
CSS-9400/add doc for rebac (#61)
Browse files Browse the repository at this point in the history
* add doc for rebac admin
  • Loading branch information
SimoneDutto authored Oct 7, 2024
1 parent 70313ad commit eb33136
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .custom_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ API
APIs
auditability
aws
Backend
balancer
certbot
Charmhub
Expand Down Expand Up @@ -71,6 +72,7 @@ observability
OEM
OIDC
OLM
OpenAPI
OpenFGA
OpenID
OpenLDAP
Expand Down
1 change: 1 addition & 0 deletions reference/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ Reference
Supported Juju Versions <juju_required_version>
Authorisation Model <authorisation_model>
Authorisation Data <authorisation_data>
ReBAC Admin Backend <rebac_admin_backend>
35 changes: 35 additions & 0 deletions reference/rebac_admin_backend.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
ReBAC Admin Backend
=======================

The ReBAC Admin API is a REST API that provides various endpoints to query or
manipulate relationships in JAAS ReBAC authorisation model.

.. hint::
For an explanation on Relationship-Based Access Control (ReBAC) check out :doc:`this <../explanation/authorisation>` explanation topic.

.. hint::
As a reference on JAAS authorisation model, check out :doc:`this <../reference/authorisation_model>` reference topic.

OpenAPI specification
---------------------
The OpenAPI spec can be found at this ``https://<jimm-deployment>/rebac/v1/swagger.json``

Authentication
--------------
These endpoints are meant to be called from a web browser, therefore the authentication is handled via Cookies.

JAAS Implementation
-------------------

JAAS implements a subset of the operations described in the OpenAPI spec.

====== ================ =========================================================================
Status Entities Notes
====== ================ =========================================================================
✅ ``entitlements``
✅ ``capabilities``
✅ ``groups``
✅ ``resources``
🟡 ``identities`` no support for creation, update and deletion.
❌ ``roles`` no support for roles.
====== ================ =========================================================================

0 comments on commit eb33136

Please sign in to comment.