keycloak-scim/topics/resource-server/enable-authorization.adoc

67 lines
3 KiB
Text
Raw Normal View History

2016-11-29 15:30:53 +00:00
[[_resource_server_enable_authorization]]
=== Enabling Authorization Services
2016-06-16 17:08:04 +00:00
To turn your OIDC Client Application into a resource server and enable fine-grained authorization, click the *Authorization Enabled* switch to *ON* and click *Save*.
2016-06-16 17:08:04 +00:00
.Enabling Authorization Services
2017-01-05 16:54:31 +00:00
image:../../{{book.images}}/resource-server/client-enable-authz.png[alt="Enabling Authorization Services"]
2016-06-16 17:08:04 +00:00
A new Authorization tab is displayed for this client. Click the *Authorization* tab and a page similar to the following is displayed:
2016-06-16 17:08:04 +00:00
.Resource Server Settings
2017-01-05 16:54:31 +00:00
image:../../{{book.images}}/resource-server/authz-settings.png[alt="Resource Server Settings"]
2016-06-16 17:08:04 +00:00
The Authorization tab contains additional sub-tabs covering the different steps that you must follow to actually protect your application's resources. Each tab is covered separately by a specific topic in this documentation. But here is a quick description about each one:
2016-06-16 17:08:04 +00:00
* *Settings*
+
General settings for your resource server. More details about this page in this section.
* *Resource*
+
2016-11-29 15:30:53 +00:00
From this page, you can manage your application's <<fake/../../resource/overview.adoc#_resource_overview, resources>>.
2016-06-16 17:08:04 +00:00
* *Scope*
+
2016-11-29 15:30:53 +00:00
From this page, you can manage <<fake/../../resource/overview.adoc#_resource_overview, scopes>>.
2016-06-16 17:08:04 +00:00
* *Policies*
+
2016-11-29 15:30:53 +00:00
From this page, you can manage <<fake/../../policy/overview.adoc#_policy_overview, authorization policies>> and define the conditions that must be met to grant a permission.
2016-06-16 17:08:04 +00:00
* *Permissions*
+
2016-11-29 15:30:53 +00:00
From this page, you can manage the <<fake/../../permission/overview.adoc#_permission_overview, permissions>> for your protected resources and scopes by linking them with the policies you created.
2016-06-16 17:08:04 +00:00
* *Evaluate*
+
2016-11-29 15:30:53 +00:00
From this page, you can <<fake/../../policy-evaluation-tool/overview.adoc#_policy_evaluation_overview, simulate authorization requests>> and view the result of the evaluation of the permissions and authorization policies you have defined.
2016-06-16 17:08:04 +00:00
==== Resource Server Settings
2016-06-16 17:08:04 +00:00
On the Resource Server Settings page, you can configure the policy enforcement mode, allow remote resource management, and export the authorization configuration settings.
2016-06-16 17:08:04 +00:00
* *Policy Enforcement Mode*
+
Specifies how policies are enforced when processing authorization requests sent to the server.
2016-06-16 17:08:04 +00:00
+
** *Enforcing*
+
(default mode) Requests are denied by default even when there is no policy associated with a given resource.
2016-06-16 17:08:04 +00:00
+
** *Permissive*
+
Requests are allowed even when there is no policy associated with a given resource.
+
2016-06-16 17:08:04 +00:00
** *Disabled*
+
Disables the evaluation of all policies and allows access to all resources.
2016-06-16 17:08:04 +00:00
+
* *Allow Remote Resource Management*
+
Specifies whether resources can be managed remotely by the resource server. If false, resources can be managed only from the administration console.
2016-06-16 17:08:04 +00:00
+
* *Export Settings*
+
You can export the authorization configuration settings to a JSON file. Click *Export* to display the complete JSON configuration for download. The configuration file contains everything defined for a resource server: protected resources, scopes, permissions, and policies.