Usercube-Export-Scim
This tool is made to export entries from a SCIM API to CSV files.
Examples
Exporting entities by specifying attributes
It is possible to export data by specifying the attribute names to fetch, for each exported table:
--server "https://scim-server.com" --connection-identifier "ConnectionSCIM" --output-path "C:/SCIMExport" --cookie-path "C:/SCIMExport" --log-level Verbose --login "usercube" --password "usercube2021" --filter-entities "Users|username eq \"john\";username name:givenName|familyName"
Exporting entities using entities defined in configuration
It is also possible to export data by specifying the Usercube's server URL, so the export tool automatically fetches the entity type mapping property names linked to the specified connection:
--server "https://scim-server.com" --login "usercube" --password "usercube2021" --connection-identifier "ConnectionSCIM" --output-path "C:/SCIMExport" --cookie-path "C:/SCIMExport" --log-level Verbose --api-url "http://localhost:5000" --api-client-id Job --api-secret secret
The server has to be running.
Exporting entities with a token authentication
It is possible to export data by specifying the attribute names to fetch, for each exported table:
--server "https://scim-server.com" --connection-identifier "ConnectionSCIM" --output-path "C:/SCIMExport" --cookie-path "C:/SCIMExport" --log-level Verbose --oauth-token "MyToken" --filter-entities "Users|username eq \"john\";username name:givenName|familyName"
Arguments
| Argument Name | Details |
|---|---|
| --cookie-path required | Type String Description Path of the cookie file for incremental export. |
| --filter-entities optional | Type String Description List of the non group entities and corresponding attributes to export. Syntax: EntityNameInSCIM1 |
| --filter-entities-group optional | Type String Description Works as �filter-entities but for entities with members. Syntax: EntityNameInSCIM1 |
| --attributes-in-filter optional | Type No Value Description Specifies true if the server is not available and the entities and their attributes to export are given in the �filter-entities and �filter-entities-group arguments. |
| --- | --- |
| --connection-identifier optional | Type String Description Connector's connection identifier. The output file will have this identifier as name. |
| --output-path required | Type String Description Output path for the files generated by the export. |
| --- | --- |
| --ignore-cookies optional | Type No Value Description Specifies the synchronization mode, its presence meaning complete, its absence incremental. |
| --- | --- |
| --server required | Type String Description URL of the SCIM endpoints of your application, not including the v2. |
| --login optional | Type String Description Specifies the login of the account you may need. |
| --password optional | Type String Description Specifies the password of the account you may need. |
| --application-id optional | Type String Description Specifies the application connection login or the login of your application's id provider. |
| --application-key optional | Type String Description Specifies the application connection password or the password of your application's id provider. |
| --oauth-url optional | Type String Description The server's url when using OAuth2 authentication. |
| --oauth-token optional | Type String Description Specifies the OAuth token to connect to the application. |
| --scim-syntax optional | Type Enum Description Specifies the syntax used for requests body. Has to be one of those values: Salesforce (default value) or CyberArk |