keycloak-scim/topics/service/protection/protection-api.adoc

== Protection API

The Protection API provides a UMA-compliant set of endpoints providing:

* *Resource Registration*
+
With this endpoint, resource servers can manage their resources remotely and enable link::../../../../enforcer/overview.adoc[Policy Enforcers] to query the server for the resources that need protection.

* *Permission Registration*
+
In the UMA protocol, resource servers access this endpoint which issues permission tickets.

An important requirement for this API is that _only_ resource servers are allowed to access its endpoints using a special OAuth2 access token called *Protection API Token* or *PAT*.
In UMA, a PAT is just a token with a scope *uma_protection*.
First bucket of documentation from docbook. 2016-05-31 20:36:14 +00:00			`== Protection API`

More doc 2016-06-05 22:17:31 +00:00			`The Protection API provides a UMA-compliant set of endpoints providing:`
First bucket of documentation from docbook. 2016-05-31 20:36:14 +00:00
			`* Resource Registration`
			`+`
[KEYCLOAK-3546] - A lot of fixes and improvements to docs from srehorn. 2016-09-09 03:53:39 +00:00			`With this endpoint, resource servers can manage their resources remotely and enable link::../../../../enforcer/overview.adoc[Policy Enforcers] to query the server for the resources that need protection.`
First bucket of documentation from docbook. 2016-05-31 20:36:14 +00:00
[KEYCLOAK-3546] - A lot of fixes and improvements to docs from srehorn. 2016-09-09 03:53:39 +00:00			`* Permission Registration`
First bucket of documentation from docbook. 2016-05-31 20:36:14 +00:00			`+`
[KEYCLOAK-3546] - A lot of fixes and improvements to docs from srehorn. 2016-09-09 03:53:39 +00:00			`In the UMA protocol, resource servers access this endpoint which issues permission tickets.`
First bucket of documentation from docbook. 2016-05-31 20:36:14 +00:00
[KEYCLOAK-3546] - A lot of fixes and improvements to docs from srehorn. 2016-09-09 03:53:39 +00:00			`An important requirement for this API is that _only_ resource servers are allowed to access its endpoints using a special OAuth2 access token called Protection API Token or PAT.`
More doc 2016-06-05 22:17:31 +00:00			`In UMA, a PAT is just a token with a scope uma_protection.`