Skip to content

Commit

Permalink
Merge branch 'docs/cleanup-4.8'
Browse files Browse the repository at this point in the history
  • Loading branch information
matusmacik committed Jan 15, 2024
2 parents ac36573 + 6fa9155 commit 8c36a45
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 18 deletions.
15 changes: 1 addition & 14 deletions docs/interfaces/rest/operations/examples/create-user.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,8 @@ include::../examples/raw/curl-authenticatoin-intro-note.adoc[]
xref:/midpoint/reference/interfaces/rest/concepts/authentication/#_basic_authentication[Authentication methods]

== Example
//TODO
.Create a new User object in MidPoint with file data source
[source,bash]
----
curl --user administrator:5ecr3t -H "Content-Type: application/xml" -X POST http://localhost:8080/midpoint/ws/rest/users --data-binary @pathToMidpointGit\samples\rest\rest-user.xml -v
----

.*Show* data source example for *"Create a new User object in MidPoint"
[%collapsible]
====
[source, xml]
----
include::https://raw.githubusercontent.com/Evolveum/midpoint-samples/master/samples/rest/user-.xml[]
----
====
include::../examples/raw/create-user-jack.adoc[]

== See Also

Expand Down
14 changes: 14 additions & 0 deletions docs/interfaces/rest/operations/examples/raw/create-user-jack.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.Create a new User object in MidPoint with file data source
[source,bash]
----
curl --user administrator:5ecr3t -H "Content-Type: application/xml" -X POST http://localhost:8080/midpoint/ws/rest/users --data-binary @pathToMidpointGit\samples\rest\user-jack.xml -v
----

.*Show* data source example for *"Create a new User object in MidPoint"*
[%collapsible]
====
[source, xml]
----
include::https://raw.githubusercontent.com/Evolveum/midpoint-samples/master/samples/rest/user-jack.xml[]
----
====
20 changes: 16 additions & 4 deletions docs/interfaces/rest/resource-types/users.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,25 +14,37 @@ User objects are a part of the REST API web resources.
users/
----

== Applicable Operations
== Operations And Examples

The User web resource 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.

[cols="a"]
|===
|.Create

include::../operations/examples/raw/create-user-jack.adoc[]

- xref:/midpoint/reference/interfaces/rest/operations/create-op-rest/[Create Operation]

|.Get
.Get Default Administrator User with REST
[source, http]
----
include::../operations/examples/raw/get-user-administrator.adoc[]
----

- xref:/midpoint/reference/interfaces/rest/operations/create-op-rest/[Create Operation]
- xref:/midpoint/reference/interfaces/rest/operations/get-op-rest/[Get Operation]
|.Search
- xref:/midpoint/reference/interfaces/rest/operations/search-op-rest/[Search Operation]
|.Modify
- xref:/midpoint/reference/interfaces/rest/operations/modify-op-rest/[Modify Operation]
|.Delete
- xref:/midpoint/reference/interfaces/rest/operations/delete-op-rest/[Delete Operation]
|.User specific
- xref:/midpoint/reference/interfaces/rest/operations/user-specific-op-rest/[User specific Operations]
|.Generate and Validate
- xref:/midpoint/reference/interfaces/rest/operations/generate-and-validate-concrete-op-rest/[Generate and Validate Operations]

|===
== Common Use-case Examples

1. xref:/midpoint/reference/interfaces/rest/operations/examples/create-object/[Create object]
Expand Down

0 comments on commit 8c36a45

Please sign in to comment.