Add RBAC (custom conditions) to Developer docs #187

pwizla · 2021-03-09T18:07:13Z

What does it do?

Describes how to define & add custom conditions for RBAC management.

Why is it needed?

There was no doc entry on how to add custom RBAC conditions yet 😅

Related issue(s)/PR(s)

The goal is to deploy it along with #118 (Add RBAC in user-guide)

meganelacheny

Thank you for adding this documentation!

I suggested some improvements. Also, on a more general note, I'm not sure we should use "you" that much in a documentation. It's fine when used here and there, but especially when explaining procedures/actions to follow, I personally prefer when it's a bit more impersonal.

docs/developer-docs/latest/setup-deployment-guides/configurations.md

derrickmehaffy · 2021-03-10T22:04:21Z

@pwizla / @meganelacheny just an FYI most of this documentation was written by @alexandrebodin originally so if there is anything that is not clear it would be best to loop him in to review as well.

docs/developer-docs/latest/setup-deployment-guides/configurations.md

lauriejim

Thanks for adding this documentation.
I added some comments.

docs/developer-docs/latest/setup-deployment-guides/configurations.md

It was not clear that higher tiers also offer the feature.

derrickmehaffy

LGTM

derrickmehaffy · 2021-03-12T15:50:05Z

@Convly / @petersg83 if either of you get some time can you just review this and make sure everything looks good to you from a backend perspective

docs/developer-docs/latest/setup-deployment-guides/configurations.md

As discussed with JS, contrary to what was stated in the draft, and based on [this blog entry](https://strapi.io/blog/announcing-3.1-role-based-access-control), a condition handler is not necessarily a function, it can also be an object.

pwizla · 2021-03-15T16:37:33Z

Thank you very much for all your reviews and comments!

@petersg83 and @Convly , just wanted to mention that this PR is ready for another (final?) review. I hope this doc is now even clearer, more inclusive and more comprehensive :-)

petersg83

Thank you, it looks good to me :)

This also allows for various registering syntaxes, one where we declare and register all at once, and one where we first declare then register the conditions.

Convly

Almost there 🎉

Convly · 2021-03-19T07:25:29Z

docs/developer-docs/latest/setup-deployment-guides/configurations.md

+
+#### Using the condition handler
+
+The condition `handler` is used to verify the condition on the entities you read, create, update or delete. It can be a query object or a function.


In fact, a condition can be applied to every permission.
The condition query object, however, will only work for permission attached to a particular subject (aka entity).

For instance, I could create a condition that allows me to access a particular page of the admin panel only if the server date is 5pm. In this scenario, my action is not related to any subject/entity and my condition would look like this: handler: () => new Date().getHours() === 17

Oh, I seeeeee! Thank you very much for clarifying, JS! Really interesting example :-)

So I updated the content with this commit.

Convly

LGTM, nice job!

pwizla · 2021-03-23T10:47:12Z

LGTM, nice job!

Thanks so much for your help! 🙌 😊

pwizla added 2 commits March 9, 2021 19:03

Add first draft of custom conditions for RBAC

413de25

Improve RBAC dev doc to follow the dev journey

ea4094d

pwizla requested review from derrickmehaffy, lauriejim and meganelacheny March 9, 2021 18:07

pwizla added the source: Dev Docs PRs/issues targeting the Developer Docs label Mar 9, 2021

pwizla changed the title ~~Developer/rbac~~ Add RBAC (custom conditions) to Developer docs Mar 9, 2021

meganelacheny reviewed Mar 10, 2021

View reviewed changes

derrickmehaffy requested changes Mar 10, 2021

View reviewed changes

pwizla requested a review from alexandrebodin March 11, 2021 09:39

Move unstable warning at top of section

ad97023

lauriejim reviewed Mar 11, 2021

View reviewed changes

pwizla added 4 commits March 11, 2021 14:55

Improve introduction of RBAC in dev docs

c9edbe2

Add all 3 badges to RBAC section title

0555f7c

It was not clear that higher tiers also offer the feature.

Improve property descriptions for RBAC custom conditions

091422c

Reword parts of RBAC dev docs for a more neutral style

3ebf959

pwizla requested review from derrickmehaffy, lauriejim and meganelacheny March 11, 2021 13:59

Remove useless parenthesis in RBAC dev intro

ca8b323

pwizla force-pushed the developer/rbac branch from bee60fe to ca8b323 Compare March 11, 2021 14:49

derrickmehaffy approved these changes Mar 12, 2021

View reviewed changes

Merge branch 'main' into developer/rbac

96dd467

derrickmehaffy requested review from Convly and petersg83 and removed request for alexandrebodin March 12, 2021 15:49

petersg83 reviewed Mar 12, 2021

View reviewed changes

docs/developer-docs/latest/setup-deployment-guides/configurations.md Outdated Show resolved Hide resolved

petersg83 reviewed Mar 12, 2021

View reviewed changes

docs/developer-docs/latest/setup-deployment-guides/configurations.md Outdated Show resolved Hide resolved

pwizla force-pushed the developer/rbac branch from 9e3580f to 457eef1 Compare March 13, 2021 09:17

pwizla added 8 commits March 15, 2021 15:53

Improve RBAC devs doc intro

63225bc

Extend RBAC handler dev doc

9c18431

As discussed with JS, contrary to what was stated in the draft, and based on [this blog entry](https://strapi.io/blog/announcing-3.1-role-based-access-control), a condition handler is not necessarily a function, it can also be an object.

Simplify and harmonize naming in RBAC dev docs

d78bcfb

Fix typo in async handler example for RBAC dev docs

a8dc784

Fix link to bootstrap.js in RBAC dev docs

6e4d42f

Extend RBAC dev docs on register() vs. registerMany()

8c40c5b

Simplify sentences & uniformize style further in RBAC dev docs

52307f4

Fix link to bootstrap.js doc entry in RBAC dev docs

6064ad2

pwizla requested review from Convly and petersg83 March 15, 2021 16:36

Add link to codebase for name RBAC condition property

afdca50

petersg83 approved these changes Mar 16, 2021

View reviewed changes

meganelacheny approved these changes Mar 17, 2021

View reviewed changes

pwizla added 4 commits March 18, 2021 17:53

Document category property in RBAC conditions

9a6d3fb

Rewrite handler documentation in RBAC conditions

dec88f6

Give examples for both register & registerMany in RBAC conditions

4213e76

This also allows for various registering syntaxes, one where we declare and register all at once, and one where we first declare then register the conditions.

Add link to user guide for condition categories in RBAC dev docs

0afa7ca

Convly reviewed Mar 19, 2021

View reviewed changes

Clarify the use of query objects in RBAC handler

61cfac3

pwizla force-pushed the developer/rbac branch from c416722 to 61cfac3 Compare March 19, 2021 09:34

pwizla added 2 commits March 20, 2021 14:31

Merge branch 'main' into developer/rbac

43d9856

Add "publish" to query objects definition in RBAC dev docs

915fa87

Convly self-requested a review March 23, 2021 10:44

Convly approved these changes Mar 23, 2021

View reviewed changes

Merge branch 'main' into developer/rbac

d203163

pwizla merged commit 0fdad30 into main Mar 24, 2021

pwizla deleted the developer/rbac branch March 24, 2021 16:28


		#### Using the condition handler

		The condition `handler` is used to verify the condition on the entities you read, create, update or delete. It can be a query object or a function.

Add RBAC (custom conditions) to Developer docs #187

Add RBAC (custom conditions) to Developer docs #187

Uh oh!

Conversation

pwizla commented Mar 9, 2021

What does it do?

Why is it needed?

Related issue(s)/PR(s)

Uh oh!

meganelacheny left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

derrickmehaffy commented Mar 10, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lauriejim left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

derrickmehaffy left a comment

Choose a reason for hiding this comment

Uh oh!

derrickmehaffy commented Mar 12, 2021

Uh oh!

Uh oh!

Uh oh!

pwizla commented Mar 15, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

petersg83 left a comment

Choose a reason for hiding this comment

Uh oh!

Convly left a comment

Choose a reason for hiding this comment

Uh oh!

Convly Mar 19, 2021

Choose a reason for hiding this comment

Uh oh!

pwizla Mar 19, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Convly left a comment

Choose a reason for hiding this comment

Uh oh!

pwizla commented Mar 23, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

pwizla commented Mar 15, 2021 •

edited

Loading

pwizla Mar 19, 2021 •

edited

Loading