Skip to content

Commit

Permalink
Fix formatting of REST authorization URLs
Browse files Browse the repository at this point in the history
Plus removed information about SOAP authorizations.
  • Loading branch information
mederly committed Feb 21, 2024
1 parent 0a07e28 commit 0a57bb9
Show file tree
Hide file tree
Showing 14 changed files with 27 additions and 81 deletions.
2 changes: 1 addition & 1 deletion docs/interfaces/rest/operations/create-op-rest.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ include::../../rest/concepts/raw/outcome.adoc[]

== Access Authorization

- `http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#addObject`
- `+http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#addObject+`

== Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/rest/operations/delete-op-rest.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ include::../../rest/concepts/raw/outcome.adoc[]

== Access Authorization

- `http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#deleteObject`
- `+http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#deleteObject+`

== Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,8 @@ include::../../rest/concepts/raw/outcome.adoc[]

== Access Authorization

- `http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#generateValue`
- `http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#validateValue`
- `+http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#generateValue+`
- `+http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#validateValue+`

== Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ include::../../rest/concepts/raw/outcome.adoc[]

== Access Authorization

- `http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#rpcGenerateValue`
- `http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#rpcValidateValue`
- `+http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#rpcGenerateValue+`
- `+http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#rpcValidateValue+`

== Examples

Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/rest/operations/get-op-rest.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -213,8 +213,8 @@ for your use case*.

== Access Authorization

- `http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#getObject`
- `http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#getSelf`
- `+http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#getObject+`
- `+http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#getSelf+`

== Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/rest/operations/modify-op-rest.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ include::../../rest/concepts/raw/outcome.adoc[]

== Access Authorization

- `http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#modifyObject`
- `+http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#modifyObject+`

== Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/rest/operations/notify-op-rest.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ include::../../rest/concepts/raw/outcome.adoc[]

== Access Authorization

- `http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#notifyChange`
- `+http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#notifyChange+`

== Examples

Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/rest/operations/resource-op-rest.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ include::../../rest/concepts/raw/outcome.adoc[]

== Access Authorization

- `http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#testResource`
- `http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#importFromResource`
- `+http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#testResource+`
- `+http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#importFromResource+`

== Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ include::../../rest/concepts/raw/outcome.adoc[]

== Access Authorization

- `http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#executeScript`
- `+http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#executeScript+`

== Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/rest/operations/search-op-rest.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ include::../../rest/concepts/raw/outcome.adoc[]

== Access Authorization

- `http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#searchObjects`
- `+http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#searchObjects+`

== Examples

Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/rest/operations/shadow-op-rest.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ include::../../rest/concepts/raw/outcome.adoc[]

== Access Authorization

- `http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#findShadowOwner`
- `http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#importShadow`
- `+http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#findShadowOwner+`
- `+http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#importShadow+`

== Examples

Expand Down
6 changes: 3 additions & 3 deletions docs/interfaces/rest/operations/task-specific-op-rest.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ include::../../rest/concepts/raw/outcome.adoc[]

== Access Authorization

- `http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#suspendTask`
- `http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#resumeTask`
- `http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#runTask`
- `+http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#suspendTask+`
- `+http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#resumeTask+`
- `+http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#runTask+`

== Examples

Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/rest/operations/user-specific-op-rest.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ include::../../rest/concepts/raw/outcome.adoc[]

== Access Authorization

- `http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#resetCredential`
- `http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#getValuePolicy`
- `+http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#resetCredential+`
- `+http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#getValuePolicy+`

== Examples

Expand Down
66 changes: 6 additions & 60 deletions docs/security/authorization/service.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,87 +10,33 @@

[%autowidth]
|===
| ID | Action | Allowed access to page
| ID | Action | Allows access to

| 1
| http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#all
| `+http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#all+`
| All operations

| 2
| http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#<operation>
| `+http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#<operation>+`
| Access to specific REST operation.
The URI fragments of individual operations are present xref:/midpoint/reference/interfaces/rest/operations/[in their description]: on pages devoted to individual operations, e.g., xref:/midpoint/reference/interfaces/rest/operations/search-op-rest/[].
These authorizations do *not* check for any specific objects, e.g., an object that is going to be retrieved or modified by the operation.
They are just "yes/no" authorizations for the operation itself.

| 3
| http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#proxy
| `+http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#proxy+`
| Authorizes the xref:/midpoint/reference/interfaces/rest/concepts/authentication/#proxy-impersonation[impersonation].

|===

== Web Service (SOAP) Authorizations

[%autowidth]
|===
| ID | Action | Allowed access to page

| 1
| http://midpoint.evolveum.com/xml/ns/public/security/authorization-ws-3#all
| All operations


| 2
| http://midpoint.evolveum.com/xml/ns/public/security/authorization-ws-3#getObject
| getObject operation


| 3
| http://midpoint.evolveum.com/xml/ns/public/security/authorization-ws-3#searchObjects
| searchObjects operation


| 4
| http://midpoint.evolveum.com/xml/ns/public/security/authorization-ws-3#executeChanges
| executeChanges operation


| 5
| http://midpoint.evolveum.com/xml/ns/public/security/authorization-ws-3#findShadowOwner
| findShadowOwner operation


| 6
| http://midpoint.evolveum.com/xml/ns/public/security/authorization-ws-3#testResource
| testResource operation


| 7
| http://midpoint.evolveum.com/xml/ns/public/security/authorization-ws-3#importFromResource
| importFromResource operation


| 8
| http://midpoint.evolveum.com/xml/ns/public/security/authorization-ws-3#notifyChange
| notifyChange operation


| 9
| http://midpoint.evolveum.com/xml/ns/public/security/authorization-ws-3#executeScripts
| executeScripts operation

|===


== Service Authorizations and Object Authorizations

WS or REST authorizations are necessary, but not sufficient condition to allow access to data in midPoint.
REST authorizations are necessary, but not sufficient condition to allow access to data in midPoint.
These authorizations are just the "first line" of defense.
The user needs to have these authorizations to invoke the service operation.
But this authorization does not give access to any data.
For practical use-cases the user must also have ordinary (object) authorizations such as _read_, _add_, _modify_ or _delete_ to access any midPoint data.
Without these authorizations the WS/REST authorizations are almost useless.

Without these authorizations the REST authorizations are almost useless.

== See Also

Expand Down

0 comments on commit 0a57bb9

Please sign in to comment.