You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 1574663
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: doc/tutorial.rst
+11-10Lines changed: 11 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -88,11 +88,11 @@ You can store those data locally and reuse them for future command runs thanks t
88
88
Query and search resources
89
89
--------------------------
90
90
91
-
Use the :ref:`query` and :ref:`search` commands to look for resources.
92
-
:ref:`query` performs a `GET` request on the resources endpoint, while :ref:`search` performs a `POST` request on the ``/.search`` endpoint.
93
-
Both commands take similar options such as :option:`--count <scim-query.--count>` or :option:`--attributes <scim-query.--attributes>`.
91
+
Use the :ref:`reference:query` and :ref:`reference:search` commands to look for resources.
92
+
:ref:`reference:query` performs a `GET` request on the resources endpoint, while :ref:`reference:search` performs a `POST` request on the ``/.search`` endpoint.
93
+
Both commands take similar options such as :option:`--count <scim-query--count>` or :option:`--attribute <scim-query --attribute>`.
94
94
An exhaustive list of options can be found on the :doc:`reference`.
95
-
:ref:`query` can also take a :option:`RESOURCE_TYPE <scim-query.RESOURCE_TYPE>` and a :option:`ID <scim-query.ID>` parameters.
95
+
:ref:`reference:query` can also take a :option:`RESOURCE_TYPE <scim-queryRESOURCE_TYPE>` and a :option:`ID <scim-queryID>` parameters.
96
96
97
97
- If none are set, all the resources of the server are queried.
98
98
@@ -109,7 +109,7 @@ An exhaustive list of options can be found on the :doc:`reference`.
109
109
"itemsPerPage": 50,
110
110
"Resources": [...]
111
111
}
112
-
- If :option:`RESOURCE_TYPE <scim-query.RESOURCE_TYPE>` is set and :option:`ID <scim-query.ID>` is unset, all the resource of the kind passed in parameter are returned.
112
+
- If :option:`RESOURCE_TYPE <scim-queryRESOURCE_TYPE>` is set and :option:`ID <scim-queryID>` is unset, all the resource of the kind passed in parameter are returned.
113
113
114
114
.. code-block:: console
115
115
:caption: Querying all the users from the server.
@@ -146,10 +146,11 @@ An exhaustive list of options can be found on the :doc:`reference`.
146
146
},
147
147
"userName": "bjensen@example.com"
148
148
}
149
+
149
150
Create and replace resources
150
151
----------------------------
151
152
152
-
Use the :ref:`create` and :ref:`replace` commands to edit resources.
153
+
Use the :ref:`reference:create` and :ref:`reference:replace` commands to edit resources.
153
154
154
155
Options for those commands are dynamically generated, depending on the resource attributes available on the server.
155
156
For instance, for the :class:`~scim2_models.User` resource, you have a ``--user-name`` option.
@@ -178,7 +179,7 @@ You can have a look at the exhaustive list of options by running ``scim create u
178
179
Delete resources
179
180
----------------
180
181
181
-
The :ref:`delete` command allows you to delete resources.
182
+
The :ref:`reference:delete` command allows you to delete resources.
182
183
183
184
.. code-block:: console
184
185
:caption: Deletion of an user.
@@ -188,7 +189,7 @@ The :ref:`delete` command allows you to delete resources.
188
189
Perform a SCIM compliance test
189
190
------------------------------
190
191
191
-
The :ref:`test` command runs a series of resource creation, edition and deletions to check that your server complies with the SCIM specifications.
192
+
The :ref:`reference:test` command runs a series of resource creation, edition and deletions to check that your server complies with the SCIM specifications.
192
193
See the :doc:`scim2-tester documentation <scim2_tester:index>` for more details on which tests are performed.
193
194
194
195
.. code-block:: console
@@ -211,7 +212,7 @@ JSON input
211
212
scim2-cli will also read input data from the standard input.
212
213
Use this to send custom payloads to the SCIM server.
213
214
214
-
When user with :ref:`query` and :ref:`search`, the input value must be a JSON representation of a :class:`~scim2_models.SearchRequest` object:
215
+
When user with :ref:`reference:query` and :ref:`reference:search`, the input value must be a JSON representation of a :class:`~scim2_models.SearchRequest` object:
215
216
216
217
.. code-block:: console
217
218
:caption: Search of an user by passing a custom payload.
@@ -227,7 +228,7 @@ When user with :ref:`query` and :ref:`search`, the input value must be a JSON re
227
228
"Resources": [...]
228
229
}
229
230
230
-
When used with :ref:`create` and :ref:`replace`, no subcommand is needed and the endpoint is guessed from the payload.
231
+
When used with :ref:`reference:create` and :ref:`reference:replace`, no subcommand is needed and the endpoint is guessed from the payload.
231
232
232
233
.. code-block:: console
233
234
:caption: Creation of an user by passing a custom payload.
0 commit comments