Skip to content

org

Organization management commands for NDCLI. These commands allow you to create, manage, and configure organizations and their members.

CommandDescription
org listList organizations
org describeShow organization details
org createCreate a new organization
org deleteDelete an organization
org set-default-ouSet the default OU
org accountManage organization accounts
org inviteManage organization invitations

List organizations you have access to.

Terminal window
ndcli org list [flags]
FlagTypeDefaultDescription
--namestringFilter by name (regex pattern)
--rolestringFilter by your role: RO, RW, SU
--statusstringFilter by status: ENABLED, DISABLED, INVITED, DECLINED
--sort-bystringname:ascSort field and direction
--pageint1Page number
--per-pageint30Items per page
RoleCodeDescription
Read-OnlyROCan view resources
Read-WriteRWCan view and modify resources
SuperuserSUFull administrative access
Terminal window
ndcli org list
ndcli org list --role SU
ndcli org list --name "prod.*"

Show detailed information about an organization.

Terminal window
ndcli org describe [name]
ArgumentRequiredDescription
nameNoOrganization name (uses default if not specified)

Shows:

  • Organization name and display name
  • Description
  • Status
  • Default OU
  • Creation date
  • Device count
  • Member count
Terminal window
ndcli org describe
ndcli org describe my-company
ndcli org describe my-company -f json

Create a new organization.

Terminal window
ndcli org create [name] [flags]
ArgumentRequiredDescription
nameYesOrganization name (URL-safe identifier)
FlagTypeDescription
--display-namestringHuman-readable display name
--descriptionstringOrganization description
Terminal window
ndcli org create acme-corp
ndcli org create acme-corp \
--display-name "ACME Corporation" \
--description "Production firewall infrastructure"
  • Organization names must be unique and URL-safe
  • You become the superuser (SU) of organizations you create

Delete an organization.

Terminal window
ndcli org delete [name]
ArgumentRequiredDescription
nameYesOrganization name to delete
Terminal window
ndcli org delete old-organization

Set the default organizational unit for new devices in the organization.

Terminal window
ndcli org set-default-ou [ou-name]
ArgumentRequiredDescription
ou-nameYesName of the OU to set as default
Terminal window
ndcli org set-default-ou staging
  • New devices will be automatically assigned to this OU when approved
  • The OU must exist in the organization

Manage organization accounts (members).

List all accounts (members) in the organization.

Terminal window
ndcli org account list

Shows for each account:

  • Email address
  • Display name
  • Role (RO, RW, SU)
  • Status (ENABLED, DISABLED)
Terminal window
ndcli org account list
ndcli org account list -f json

Set the role for a user account.

Terminal window
ndcli org account role [email] [role]
ArgumentRequiredDescription
emailYesUser email address
roleYesRole to assign
RoleAliasesDescription
SUsuperuserFull administrative access
RWreadwriteCan view and modify resources
ROreadonlyCan only view resources
Terminal window
ndcli org account role user@example.com SU
ndcli org account role user@example.com readonly

Enable a disabled account.

Terminal window
ndcli org account enable [email]
Terminal window
ndcli org account enable user@example.com

Disable an account, optionally removing it permanently.

Terminal window
ndcli org account disable [email] [flags]
FlagTypeDefaultDescription
--removeboolfalsePermanently remove the account
Terminal window
ndcli org account disable user@example.com
ndcli org account disable user@example.com --remove

Manage organization invitations.

List pending invitations for the organization (sent invitations) or for yourself (received invitations).

Terminal window
ndcli org invite list
Terminal window
ndcli org invite list

Send an invitation to join the organization.

Terminal window
ndcli org invite send [email] [flags]
ArgumentRequiredDescription
emailYesEmail address to invite
FlagTypeDefaultDescription
--rolestringRORole to assign: SU, RW, RO
Terminal window
ndcli org invite send newuser@example.com
ndcli org invite send admin@example.com --role RW

Accept an invitation to join an organization.

Terminal window
ndcli org invite accept [org-name]
ArgumentRequiredDescription
org-nameYesName of the organization to join
Terminal window
ndcli org invite accept acme-corp

Decline an invitation to join an organization.

Terminal window
ndcli org invite decline [org-name]
ArgumentRequiredDescription
org-nameYesName of the organization
Terminal window
ndcli org invite decline some-org

Revoke a pending invitation (requires superuser privileges).

Terminal window
ndcli org invite revoke [email]
ArgumentRequiredDescription
emailYesEmail address of the invitee
Terminal window
ndcli org invite revoke cancelled-user@example.com