Merge branch 'docs/cleanup-4.8'

docs/interfaces/rest/resource-types/organizational-units.adoc → docs/interfaces/rest/endpoints/organizational-units.adoc

@@ -69,14 +69,18 @@ include::../operations/examples/raw/modify-id-generate.adoc[]
 
 - xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest/[Generate and Validate Operations]
 
+== Common Use-case Examples
+
+1.
+
 == JSON Example
 
 Example output of information regarding a specific object. Some data vas omitted to simplify the example.
 
 .Show JSON Example
 [%collapsible]
 ====
-[source, http]
+[source, json]
 ----
 {
   "org" : {

docs/interfaces/rest/endpoints/resources.adoc

@@ -0,0 +1,187 @@
+= Resource Type
+:page-nav-title: Resource
+:page-display-order: 700
+:page-toc: top
+
+== Description
+
+Here we are describing the Resource object type in relation to midPoints REST API. The
+Resource objects are a part of the REST API web resources.
+
+.Endpoint
+[source, http]
+----
+resources/
+----
+
+== Operations And Examples
+
+The Resource endpoint is a part of the Create-Read-Update-Delete (CRUD) web resources
+present in midPoint. This is apparent in the operations which are available for this type of object.
+
+=== Create Resource Objects
+
+include::../operations/examples/raw/create-resource.adoc[]
+
+- xref:/midpoint/reference/interfaces/rest/operations/create-op-rest/[Create Operation]
+
+=== Get Resource Type Objects
+
+Get operation for fetching a single specific object.
+
+.Get Resource Type object with REST
+
+include::../operations/examples/raw/get-resource.adoc[]
+
+- xref:/midpoint/reference/interfaces/rest/operations/get-op-rest/[Get Operation]
+
+=== Search for Resource Type Objects
+
+Search operation usable for fetching the full list of objects or a list based on filter.
+
+include::../operations/examples/raw/search-all-resource.adoc[]
+
+include::../operations/examples/raw/search-all.adoc[]
+
+- xref:/midpoint/reference/interfaces/rest/operations/search-op-rest/[Search Operation]
+
+=== Modify Resource Type Objects
+
+include::../operations/examples/raw/modify-attr-resource.adoc[]
+
+include::../operations/examples/raw/modify-attr-res-cap.adoc[]
+
+- xref:/midpoint/reference/interfaces/rest/operations/modify-op-rest/[Modify Operation]
+
+=== Delete Resource Type Objects
+
+include::../operations/examples/raw/delete-resource.adoc[]
+
+- xref:/midpoint/reference/interfaces/rest/operations/delete-op-rest/[Delete Operation]
+
+=== Generate and Validate Operations for Resource Type Objects
+
+Operations to generate or validate values.
+
+- xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest/[Generate and Validate Operations]
+
+=== Operations specific for Resources
+
+include::../operations/examples/raw/test-resource.adoc[]
+
+include::../operations/examples/raw/import-from-resource.adoc[]
+
+- xref:/midpoint/reference/interfaces/rest/operations/resource-op-rest.adoc[Resource Specific Operations]
+
+== Common Use-case Examples
+
+1.
+
+== JSON Example
+
+Example output of information regarding a specific object. Some data vas omitted to simplify the example.
+
+.Show JSON Example
+[%collapsible]
+====
+[source, json]
+----
+{
+  "resource" : {
+    "oid" : "ef2bc95b-76e0-59e2-86d6-9999cccccccc",
+    "version" : "1",
+    "name" : "Test CSV: username",
+    "description" : "Simple CSV resource that is using single identifier (username)",
+    "metadata" : {},
+    "operationExecution" : {},
+    "iteration" : 0,
+    "iterationToken" : "",
+    "connectorRef" : {
+      "oid" : "01aa0a9e-dfe0-47c8-8fca-4446894a348c",
+      "relation" : "org:default",
+      "type" : "c:ConnectorType",
+      "filter" : {
+        "equal" : {
+          "path" : "c:connectorType",
+          "value" : "com.evolveum.polygon.connector.csv.CsvConnector"
+        }
+      }
+    },
+    "connectorConfiguration" : {
+      "@ns" : "http://midpoint.evolveum.com/xml/ns/public/connector/icf-1/connector-schema-3",
+      "configurationProperties" : {
+        "@ns" : "http://midpoint.evolveum.com/xml/ns/public/connector/icf-1/bundle/com.evolveum.polygon.connector-csv/com.evolveum.polygon.connector.csv.CsvConnector",
+        "multivalueDelimiter" : ";",
+        "fieldDelimiter" : ",",
+        "filePath" : "target/midpoint.csv",
+        "encoding" : "utf-8",
+        "passwordAttribute" : "password",
+        "uniqueAttribute" : "username"
+      }
+    },
+    "schemaHandling" : {
+      "objectType" : {
+        "@id" : 1,
+        "displayName" : "Default Account",
+        "default" : true,
+        "objectClass" : "ri:AccountObjectClass",
+        "attribute" : [ {
+          "@id" : 2,
+          "ref" : "ri:username",
+          "outbound" : {
+            "source" : {
+              "path" : "$user/name"
+            }
+          }
+        }, {
+          "@id" : 3,
+          "ref" : "ri:firstname",
+          "outbound" : {
+            "source" : {
+              "path" : "$user/givenName"
+            }
+          }
+        }, {
+          "@id" : 4,
+          "ref" : "ri:lastname",
+          "outbound" : {
+            "source" : {
+              "path" : "$user/familyName"
+            }
+          }
+        } ],
+        "activation" : {
+          "administrativeStatus" : {
+            "outbound" : {
+              "@id" : 5
+            }
+          }
+        },
+        "credentials" : {
+          "password" : {
+            "outbound" : {
+              "@id" : 6
+            }
+          }
+        }
+      }
+    },
+    "capabilities" : {
+      "configured" : {
+        "activation" : {
+          "status" : {
+            "attribute" : "ri:disabled",
+            "enableValue" : "false",
+            "disableValue" : "true"
+          }
+        }
+      }
+    }
+  }
+}
+----
+====
+
+== See Also
+- xref:/midpoint/reference/interfaces/rest/concepts/media-types-rest/[Supported Media Types]
+- xref:/midpoint/reference/interfaces/rest/concepts/authentication/[Authentication]

docs/interfaces/rest/resource-types/roles.adoc → docs/interfaces/rest/endpoints/roles.adoc

@@ -70,14 +70,18 @@ include::../operations/examples/raw/modify-id-generate.adoc[]
 
 - xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest/[Generate and Validate Operations]
 
+== Common Use-case Examples
+
+1.
+
 == JSON Example
 
 Example output of information regarding a specific object. Some data vas omitted to simplify the example.
 
 .Show JSON Example
 [%collapsible]
 ====
-[source, http]
+[source, json]
 ----
 {
   "role" : {

docs/interfaces/rest/endpoints/rpc.adoc

@@ -0,0 +1,54 @@
+= RPC REST Endpoint
+:page-nav-title: RPC
+:page-display-order: 2800
+:page-toc: top
+
+== Description
+
+Here we are describing the RPC (Remote Procedure Call) endpoint in relation to midPoints REST API.
+
+.Endpoint
+[source, http]
+----
+rpc/
+----
+== Operations And Examples
+
+The Remote Procedure Call endpoint gives you the possibility to execute commands and scripts of various
+nature on midPoint.
+
+=== Execute Script
+
+include::../operations/examples/raw/execute-script-rpc.adoc[]
+
+- xref:/midpoint/reference/interfaces/rest/operations/script-execute-op-rest.adoc[Script Execute Operation]
+
+=== Generate and Validate Value
+
+include::../operations/examples/raw/validate-value-rpc.adoc[]
+
+- xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-op-rest.adoc[Generate and Validate value Operation]
+
+
+
+== Common Use-case Examples
+
+1.
+
+
+== JSON Example
+
+-- TODO
+
+.Show JSON Example
+[%collapsible]
+====
+[source, http]
+----
+TODO
+----
+====
+
+== See Also
+- xref:/midpoint/reference/interfaces/rest/concepts/media-types-rest/[Supported Media Types]
+- xref:/midpoint/reference/interfaces/rest/concepts/authentication/[Authentication]

docs/interfaces/rest/endpoints/shadows.adoc

@@ -0,0 +1,89 @@
+= Shadows Type REST Endpoint
+:page-nav-title: Shadows
+:page-display-order: 800
+:page-toc: top
+
+== Description
+
+Here we are describing the Shadows object type in relation to midPoints REST API. The
+Shadows objects are a part of the REST API web resources.
+
+.Endpoint
+[source, http]
+----
+shadows/
+----
+
+== Operations And Examples
+
+The Shadow web endpoint provides us with information regarding resource shadows.
+Resource shadow objects are usually created and modified automatically by midPoint, most
+often the use cases will resolve around fetching and reading the shadow object data.
+
+// === Create Shadow Object
+
+
+// - xref:/midpoint/reference/interfaces/rest/operations/create-op-rest/[Create Operation]
+
+=== Get Shadow Object
+
+Get operation for fetching a single specific object.
+
+.Get Shadow with REST
+
+- xref:/midpoint/reference/interfaces/rest/operations/get-op-rest/[Get Operation]
+
+=== Search for Shadow Objects
+
+Search operation usable for fetching the full list of objects or a list based on filter.
+
+// include::../operations/examples/raw/search-all-shadows.adoc[]
+
+include::../operations/examples/raw/search-all.adoc[]
+
+- xref:/midpoint/reference/interfaces/rest/operations/search-op-rest/[Search Operation]
+
+// === Modify Shadow Objects
+//
+// include::../operations/examples/raw/modify-attr.adoc[]
+//
+// - xref:/midpoint/reference/interfaces/rest/operations/modify-op-rest/[Modify Operation]
+
+=== Delete Shadow Objects
+
+Object deletion.
+//
+// include::../operations/examples/raw/delete-shadow.adoc[]
+
+- xref:/midpoint/reference/interfaces/rest/operations/delete-op-rest/[Delete Operation]
+
+=== Shadow Object Specific Operations
+
+A set of operations specific for the Shadow REST objects.
+
+- xref:/midpoint/reference/interfaces/rest/operations/shadow-op-rest/[Shadow specific Operations]
+
+// === Generate and Validate operations for Shadow Objects
+//
+// Operations to generate or validate values, here we have an example of a simple password generate use-case.
+//
+//
+// - xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest/[Generate and Validate Operations]
+
+== JSON Example
+
+Example output of information regarding a specific Shadows object.
+Metadata is usually a part of the output, yet it was removed for the purpose of the example.
+
+.Show JSON Example
+[%collapsible]
+====
+[source, http]
+----
+TODO
+----
+====
+
+== See Also
+- xref:/midpoint/reference/interfaces/rest/concepts/media-types-rest/[Supported Media Types]
+- xref:/midpoint/reference/interfaces/rest/concepts/authentication/[Authentication]