Skip to main content

Usercube-Export-Scim-2.0

This tool exports entries from a SCIM 2.0 API (RFC 7644) to CSV files.

Examples

Exporting using entities defined in configuration

Export data by pointing to the Identity Manager server, which automatically fetches entity type mapping property names for the specified connection:

--server "https://scim-server.com/scim/v2" --connection-identifier "ConnectionSCIMv2" --output-path "C:/SCIMv2Export" --cookie-path "C:/SCIMv2Export" --log-level Verbose --api-url "http://localhost:5000" --api-client-id Job --api-secret secret

Exporting with OAuth2 client credentials

--server "https://scim-server.com/scim/v2" --connection-identifier "ConnectionSCIMv2" --output-path "C:/SCIMv2Export" --cookie-path "C:/SCIMv2Export" --application-id "clientId" --application-key "clientSecret" --oauth2-url "https://idp.example.com/oauth/token"

Exporting with a static bearer token

--server "https://scim-server.com/scim/v2" --connection-identifier "ConnectionSCIMv2" --output-path "C:/SCIMv2Export" --cookie-path "C:/SCIMv2Export" --oauth-token "MyToken"

Arguments

Argument NameDetails
--cookie-path requiredType String Description Path of the folder used to store the incremental export cookie file.
--output-path requiredType String Description Output folder for the CSV files generated by the export.
--connection-identifier optionalType String Description Connector's connection identifier. Used as a prefix for output file names.
--ignore-cookies optionalType No Value Description Forces a complete export. When absent, the export runs incrementally using the existing cookie.
------
--server requiredType String Description Full SCIM base URL including the version path segment (e.g. https://idp.example.com/scim/v2).
--oauth-token optionalType String Description Pre-acquired bearer token. Takes priority over OAuth2 and Basic auth.
--oauth2-url optionalType String Description OAuth2 token endpoint URL. OIDC discovery is attempted against --server when omitted.
--application-id optionalType String Description OAuth2 client ID.
--application-key optionalType String Description OAuth2 client secret.
--login optionalType String Description Login for password-flow OAuth2 or HTTP Basic auth.
--password optionalType String Description Password for password-flow OAuth2 or HTTP Basic auth.
--scope optionalType String Description Space-separated OAuth2 scopes to request.
--resource optionalType String Description RFC 8707 resource indicator.
--page-size optionalType Int32 Description Number of resources returned per page request. Default: 100.