zorg commands

  • 1 minute(s) read
Prev Next

Use zorg commands to work with your ZOrgs.

Commands

Command Description
zorg:list Lists all ZOrgs you've signed in to from this computer.
zorg:login Obtains an OAuth token to work with a ZOrg.
zorg:logout Deactivates the OAuth token for a ZOrg.
Tips
  • Run the zdx commands command to list all supported commands.
  • All Zilliant CLI commands support the --help parameter. Run a command with this parameter for a description and list of supported parameters.

zdx zorg:list

Lists all ZOrgs you've signed into from this computer and indicates whether their OAuth tokens are still valid.

Parameters

None.

zdx zorg:login

Obtains an OAuth token from Salesforce to work with your ZOrg. The token is valid for up to 8 hours.

Parameters

  • -c | --client-id (Required.) Client ID of the connected authorization app in Salesforce.
  • -s | --client-secret (Required.) Client secret of the connected authorization app in Salesforce.
  • -t | --is-sandbox (Optional.) Boolean to define whether your ZOrg is a test or sandbox org. The default value is false.
  • -z | --zorg-id (Required.) ZOrg ID.
  • -a | --alias (Optional.) The alias to assign to your ZOrg ID.
Note

Contact your Zilliant representative to get the client ID, client secret, and ZOrg ID.

The command output includes a URL and a code to proceed with obtaining a token. For details, refer to Sign in to ZOrgs.

Example

PS C:\Users\username> zdx zorg:login -c clientID -s OAuthSecret -z ZorgID
Please enter 'code' on the Salesforce page that opened or navigate to URL and enter it there. It should have been automatically copied to your clipboard.

zdx zorg:logout

Deactivates the OAuth token for a ZOrg.

Parameters

-z | --zorg-id (Required.) ID or alias of the ZOrg for which you want to deactivate the OAuth token.