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

[[_service_protection_api]]
== 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 <<fake/../../../enforcer/overview.adoc#_enforcer_overview, 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 a protection API token (PAT).
In UMA, a PAT is a token with the scope *uma_protection*.
[RHSSO-599] - Replacing link with fake 2016-11-29 15:30:53 +00:00			`[[_service_protection_api]]`
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`
			`+`
[RHSSO-599] - Replacing link with fake 2016-11-29 15:30:53 +00:00			`With this endpoint, resource servers can manage their resources remotely and enable <<fake/../../../enforcer/overview.adoc#_enforcer_overview, 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			`+`
General cleanup and edits of the documentation 2016-11-15 21:34:20 +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
General cleanup and edits of the documentation 2016-11-15 21:34:20 +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 a protection API token (PAT).`
			`In UMA, a PAT is a token with the scope uma_protection.`