How-to: connection

Connect and verify identity, taken from the CRMWorx build (§1). See the CLI reference for every flag.

Confirm reachability and identity

crm --json connection whoami

Returns UserId / BusinessUnitId / OrganizationId; a non-zero exit (e.g. 401) means the DOMAIN\username credentials are wrong.

Save a targeting profile (validates credentials)

crm --json connection connect \
  --url "$CRM_BASE_URL" --username "$CRM_USERNAME" \
  --api-version v9.1 \
  --default-solution CRMWorx --publisher-prefix cwx \
  --profile-name crmworx

Saves the profile and runs a WhoAmI check. --password is accepted, but prefer D365_PASSWORD (e.g. from a .env file) to keep the secret off the command line and out of the process list; see the CLI reference.

Inspect saved profiles and the active session

crm --json connection profiles
crm --json connection status

profiles lists every saved profile; status confirms the active_profile with its default_solution and publisher_prefix (no network call).