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
Copy file name to clipboardExpand all lines: doc/tutorial.rst
+12Lines changed: 12 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,7 @@ As a start you will need to instantiate a httpx :code:`Client` (or :code:`AsyncC
11
11
In addition to your SCIM server root endpoint, you will probably want to provide some authorization headers through the httpx :code:`Client` :code:`headers` parameter:
12
12
13
13
.. tab-set::
14
+
:class: outline
14
15
15
16
.. tab-item:: Sync
16
17
:sync: sync
@@ -53,6 +54,7 @@ and dynamically generate local Python models based on those schemas.
53
54
They are then available to use with :meth:`~scim2_client.SCIMClient.get_resource_model`.
54
55
55
56
.. tab-set::
57
+
:class: outline
56
58
57
59
.. tab-item:: Sync
58
60
:sync: sync
@@ -80,6 +82,7 @@ To manually register models and resource types, you can simply use the :paramref
80
82
81
83
82
84
.. tab-set::
85
+
:class: outline
83
86
84
87
.. tab-item:: Sync
85
88
:sync: sync
@@ -115,6 +118,7 @@ To manually register models and resource types, you can simply use the :paramref
115
118
and simply call :meth:`~scim2_client.SCIMClient.register_naive_resource_types`.
116
119
117
120
.. tab-set::
121
+
:class: outline
118
122
119
123
.. tab-item:: Sync
120
124
:sync: sync
@@ -154,6 +158,7 @@ Create
154
158
:meth:`~scim2_client.BaseSyncSCIMClient.create` issues a ``POST`` to provision a new resource:
155
159
156
160
.. tab-set::
161
+
:class: outline
157
162
158
163
.. tab-item:: Sync
159
164
:sync: sync
@@ -179,6 +184,7 @@ Query
179
184
:meth:`~scim2_client.BaseSyncSCIMClient.query` issues a ``GET`` to read a single resource by its id, or list resources of a given type:
180
185
181
186
.. tab-set::
187
+
:class: outline
182
188
183
189
.. tab-item:: Sync
184
190
:sync: sync
@@ -212,6 +218,7 @@ Search
212
218
:meth:`~scim2_client.BaseSyncSCIMClient.search` issues a ``POST`` on the ``/.search`` endpoint to query across all resource types at once:
213
219
214
220
.. tab-set::
221
+
:class: outline
215
222
216
223
.. tab-item:: Sync
217
224
:sync: sync
@@ -233,6 +240,7 @@ Replace
233
240
:meth:`~scim2_client.BaseSyncSCIMClient.replace` issues a ``PUT`` to fully overwrite an existing resource:
234
241
235
242
.. tab-set::
243
+
:class: outline
236
244
237
245
.. tab-item:: Sync
238
246
:sync: sync
@@ -258,6 +266,7 @@ Delete
258
266
:meth:`~scim2_client.BaseSyncSCIMClient.delete` issues a ``DELETE`` and returns :data:`None` on success:
259
267
260
268
.. tab-set::
269
+
:class: outline
261
270
262
271
.. tab-item:: Sync
263
272
:sync: sync
@@ -279,6 +288,7 @@ Modify
279
288
:meth:`~scim2_client.BaseSyncSCIMClient.modify` issues a ``PATCH`` to apply partial updates as defined in :rfc:`RFC7644 §3.5.2 <7644#section-3.5.2>`:
280
289
281
290
.. tab-set::
291
+
:class: outline
282
292
283
293
.. tab-item:: Sync
284
294
:sync: sync
@@ -321,6 +331,7 @@ By default, if the server returns an error, a :class:`~scim2_client.SCIMResponse
321
331
The :meth:`~scim2_client.SCIMResponseErrorObject.to_error` method gives access to the :class:`~scim2_models.Error` object:
322
332
323
333
.. tab-set::
334
+
:class: outline
324
335
325
336
.. tab-item:: Sync
326
337
:sync: sync
@@ -396,6 +407,7 @@ Pass additional parameters directly to the underlying engine methods.
396
407
This can be useful if you need to explicitly pass a certain URL for example:
0 commit comments