Skip to content

org

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

Commands

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

org list

List organizations you have access to.

Terminal window
ndcli org list [flags]

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

Roles

RoleCodeDescription
Read-OnlyROCan view resources
Read-WriteRWCan view and modify resources
SuperuserSUFull administrative access

Examples

Terminal window
ndcli org list
ndcli org list --role SU
ndcli org list --name "prod.*"

org describe

Show detailed information about an organization.

Terminal window
ndcli org describe [name]

Arguments

ArgumentRequiredDescription
nameNoOrganization name (uses default if not specified)

Output

Shows:

  • Organization name and display name
  • Description
  • Status
  • Default OU
  • Creation date
  • Device count
  • Member count

Examples

Terminal window
ndcli org describe
ndcli org describe my-company
ndcli org describe my-company -f json

org create

Create a new organization.

Terminal window
ndcli org create [name] [flags]

Arguments

ArgumentRequiredDescription
nameYesOrganization name (URL-safe identifier)

Flags

FlagTypeDescription
--display-namestringHuman-readable display name
--descriptionstringOrganization description

Examples

Terminal window
ndcli org create acme-corp
ndcli org create acme-corp \
--display-name "ACME Corporation" \
--description "Production firewall infrastructure"

Notes

  • Organization names must be unique and URL-safe
  • You become the superuser (SU) of organizations you create

org delete

Delete an organization.

Terminal window
ndcli org delete [name]

Arguments

ArgumentRequiredDescription
nameYesOrganization name to delete

Examples

Terminal window
ndcli org delete old-organization

org set-default-ou

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

Terminal window
ndcli org set-default-ou [ou-name]

Arguments

ArgumentRequiredDescription
ou-nameYesName of the OU to set as default

Examples

Terminal window
ndcli org set-default-ou staging

Notes

  • New devices will be automatically assigned to this OU when approved
  • The OU must exist in the organization

org account

Manage organization accounts (members).

org account list

List all accounts (members) in the organization.

Terminal window
ndcli org account list

Output

Shows for each account:

  • Email address
  • Display name
  • Role (RO, RW, SU)
  • Status (ENABLED, DISABLED)

Examples

Terminal window
ndcli org account list
ndcli org account list -f json

org account role

Set the role for a user account.

Terminal window
ndcli org account role [email] [role]

Arguments

ArgumentRequiredDescription
emailYesUser email address
roleYesRole to assign

Valid Roles

RoleAliasesDescription
SUsuperuserFull administrative access
RWreadwriteCan view and modify resources
ROreadonlyCan only view resources

Examples

Terminal window
ndcli org account role user@example.com SU
ndcli org account role user@example.com readonly

org account enable

Enable a disabled account.

Terminal window
ndcli org account enable [email]

Examples

Terminal window
ndcli org account enable user@example.com

org account disable

Disable an account, optionally removing it permanently.

Terminal window
ndcli org account disable [email] [flags]

Flags

FlagTypeDefaultDescription
--removeboolfalsePermanently remove the account

Examples

Terminal window
ndcli org account disable user@example.com
ndcli org account disable user@example.com --remove

org invite

Manage organization invitations.

org invite list

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

Terminal window
ndcli org invite list

Examples

Terminal window
ndcli org invite list

org invite send

Send an invitation to join the organization.

Terminal window
ndcli org invite send [email] [flags]

Arguments

ArgumentRequiredDescription
emailYesEmail address to invite

Flags

FlagTypeDefaultDescription
--rolestringRORole to assign: SU, RW, RO

Examples

Terminal window
ndcli org invite send newuser@example.com
ndcli org invite send admin@example.com --role RW

org invite accept

Accept an invitation to join an organization.

Terminal window
ndcli org invite accept [org-name]

Arguments

ArgumentRequiredDescription
org-nameYesName of the organization to join

Examples

Terminal window
ndcli org invite accept acme-corp

org invite decline

Decline an invitation to join an organization.

Terminal window
ndcli org invite decline [org-name]

Arguments

ArgumentRequiredDescription
org-nameYesName of the organization

Examples

Terminal window
ndcli org invite decline some-org

org invite revoke

Revoke a pending invitation (requires superuser privileges).

Terminal window
ndcli org invite revoke [email]

Arguments

ArgumentRequiredDescription
emailYesEmail address of the invitee

Examples

Terminal window
ndcli org invite revoke cancelled-user@example.com