867eff3e5d
* [KEYCLOAK-3169] - Updating authz services doc * [KEYCLOAK-3169] - Section about changes to user account service * [KEYCLOAK-3169] - Removing UMA 1.0 references * [KEYCLOAK-3169] - RH-SSO images * [KEYCLOAK-3169] - Updating Keycloak images * [KEYCLOAK-3169] - Review * [KEYCLOAK-3169] - Review
16 lines
783 B
Text
16 lines
783 B
Text
[[_service_protection_api]]
|
|
= Protection API
|
|
|
|
The Protection API provides a UMA-compliant set of endpoints providing:
|
|
|
|
* *Resource Management*
|
|
+
|
|
With this endpoint, resource servers can manage their resources remotely and enable <<_enforcer_overview, policy enforcers>> to query the server for the resources that need protection.
|
|
|
|
* *Permission Management*
|
|
+
|
|
In the UMA protocol, resource servers access this endpoint to create permission tickets. {project_name} also provides
|
|
endpoints to manage the state of permissions and query permissions.
|
|
|
|
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*.
|