sync-all-users¶

Description¶

Synchronizes environments with all users and groups state with CDP.

Synopsis¶

  sync-all-users
[--environment-names <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--environment-names (array)

List of environments to be synced. If not present, all environments will be synced.

Syntax:

"string" "string" ...

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

operationId -> (string)

UUID of the request for this operation. This Id can be used for geting status on the operation.

operationType -> (string)

Operation Type.

status -> (string)

Status of a sync operation.

success -> (array)

List of sync operation details for all succeeded environments.

item -> (object)

Details object of the sync operation for success or falure.

environmentCrn -> (string)

environment crn.

message -> (string)

The detail of the success or failure.

failure -> (array)

List of sync operation details for all failed envs.

item -> (object)

Details object of the sync operation for success or falure.

environmentCrn -> (string)

environment crn.

message -> (string)

The detail of the success or failure.

error -> (string)

If there is any error associated.

startTime -> (string)

Sync operation start timestamp.

endTime -> (string)

Sync operation end timestamp.

Form Factors¶

public, private