Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter

Short
hand

Description

--cxoUrl

N/A

URL of CXO

--idpUrl

N/A

URL of the CXO identity provider.

--clientId

-c

Identity provider - client Id. See the Security section on how to obtain this value.

--privateKey

-p

Identity provider - client private key. See the Security section on how to obtain this value.

--input

-i

Path of the input file. See the Inputs section.

--applicationsFile

-a

The file path to a list of applications to synchronize.

--masterDatabaseConnectionString

-m

Connection string of the master database. Using this option all applications (from given master database) will be synchronized.

If this option is set, (-a --applicationsFile) option should not be set.

--filterApplications

-f

A comma-separated list of application
names. You may use this option when (-m,
--masterDatabaseConnectionString) is
set to filter the applications to synchronize.

--maxParallelism

-P

Default(1) . Represents the max number of applications to synchronize in parallel. This value should be at most equal to the amount of CXO instances available.

--init

N/A

Initializes the input file and applicationsFile with an example text at the path specified to each parameter.

Endpoints

As described in the Deployment section, the CLI interacts with CXO. For that reason, you need to provide CXO and IDP URLs using --cxoUrl and --idpUrl options, respectivelly.

These URLs can be easily found in the CXO Configurator → Settings tab (see example below)

...

Security

In order for CXO to process the User synchronization request, the CLI to be authenticated by the CXO Identity Provider (IDP). This is done by associating the CLI with a certain type of IDP client.

...