keycloak-scim/authorization_services/topics/permission-create-scope.adoc
Erik Jan de Wit f55b704052
updated to reflect the new ui (#1531)
* updated to reflect the new ui

fixes: #1500

* pr review comments
2022-06-01 07:43:49 -04:00

47 lines
1.8 KiB
Text

[[_permission_create_scope]]
= Creating scope-based permissions
A scope-based permission defines a set of one or more scopes to protect using a set of one or more authorization policies. Unlike resource-based permissions, you can use this permission type to create permissions not only for a resource, but also for the scopes associated with it, providing more granularity when defining the permissions that govern your resources and the actions that can be performed on them.
ifeval::[{project_community}==true]
To create a new scope-based permission, select *Create scope-based permission* from the *Create permission* dropdown.
endif::[]
ifeval::[{project_product}==true]
To create a new scope-based permission, select *Scope-based* in the item list in the upper right corner of the permission listing.
endif::[]
.Add Scope Permission
image:{project_images}/permission/create-scope.png[alt="Add Scope Permission"]
== Configuration
* *Name*
+
A human-readable and unique string describing the permission. A best practice is to use names that are closely related to your business and security requirements, so you
can identify them more easily.
+
* *Description*
+
A string containing details about this permission.
+
* *Resource*
+
Restricts the scopes to those associated with the selected resource. If none is selected, all scopes are available.
+
* *Scopes*
+
Defines a set of one or more scopes to protect.
ifeval::[{project_community}==true]
* *Policy*
endif::[]
ifeval::[{project_product}==true]
* *Apply Policy*
endif::[]
+
Defines a set of one or more policies to associate with a permission. To associate a policy you can either select an existing policy
or create a new one by selecting the type of the policy you want to create.
* *Decision Strategy*
+
The <<_permission_decision_strategies, Decision Strategy>> for this permission.