@@ -6,8 +6,8 @@ The :ref:`cli` command allows you to interact with a SCIM server.
66Basic parameters
77----------------
88
9- In order to connect to a SCIM server you will need to pass the :option: `scim --url ` parameter.
10- You can also pass additional headers, such as authentication ones, with :option: `scim --url `.
9+ In order to connect to a SCIM server you will need to pass the :option: `--url < scim --url> ` parameter.
10+ You can also pass additional headers, such as authentication ones, with :option: `--header < scim --header> `.
1111
1212.. code-block :: shell
1313
@@ -45,3 +45,24 @@ To make commands shorter, you can set those parameters once for all by using the
4545 " location" : " https://example.com/v2/Users/2819c223-7f76-453a-919d-413861904646" ,
4646 },
4747 }
48+
49+
50+ Server configuration
51+ --------------------
52+
53+ The CLI needs to reach the server configuration to find out which features are available,
54+ which resource schemas are available, and where they are located.
55+
56+ By default the CLI will automatically discover those resources on the server, before each command is run.
57+
58+ However you might find too time consuming to achieve all those network requests.
59+ You can store those data locally and reuse them for future command runs thanks to the
60+ :option: `--schemas <scim --schemas> `, :option: `--resource-types <scim --resource-types> ` and :option: `--service-provider-config <scim --service-provider-config> ` (and their corresponding environment vars :ref: `SCIM_CLI_SCHEMAS <scim-schemas-scim_cli_schemas >`, :ref: `SCIM_CLI_RESOURCE_TYPES <scim-resource_types-scim_cli_resource_types >` and :ref: `SCIM_CLI_SERVICE_PROVIDER_CONFIG <scim-service_provider_config-scim_cli_service_provider_config >`)
61+
62+ .. code-block :: shell
63+ :caption: Load the cached resources
64+
65+ $ export SCIM_SCHEMAS=/tmp/schemas.json
66+ $ export SCIM_RESOURCE_TYPES=/tmp/resource-types.json
67+ $ export SCIM_SERVICE_PROVIDER_CONFIG=/tmp/service-provider-config.json
68+ $ scim2 query ...
0 commit comments