org
Organization management commands for NDCLI. These commands allow you to create, manage, and configure organizations and their members.
Commands
Section titled “Commands”| Command | Description |
|---|---|
org list | List organizations |
org describe | Show organization details |
org create | Create a new organization |
org delete | Delete an organization |
org set-default-ou | Set the default OU |
org account | Manage organization accounts |
org invite | Manage organization invitations |
org list
Section titled “org list”List organizations you have access to.
ndcli org list [flags]| Flag | Type | Default | Description |
|---|---|---|---|
--name | string | Filter by name (regex pattern) | |
--role | string | Filter by your role: RO, RW, SU | |
--status | string | Filter by status: ENABLED, DISABLED, INVITED, DECLINED | |
--sort-by | string | name:asc | Sort field and direction |
--page | int | 1 | Page number |
--per-page | int | 30 | Items per page |
| Role | Code | Description |
|---|---|---|
| Read-Only | RO | Can view resources |
| Read-Write | RW | Can view and modify resources |
| Superuser | SU | Full administrative access |
Examples
Section titled “Examples”ndcli org list
ndcli org list --role SU
ndcli org list --name "prod.*"org describe
Section titled “org describe”Show detailed information about an organization.
ndcli org describe [name]Arguments
Section titled “Arguments”| Argument | Required | Description |
|---|---|---|
name | No | Organization name (uses default if not specified) |
Output
Section titled “Output”Shows:
- Organization name and display name
- Description
- Status
- Default OU
- Creation date
- Device count
- Member count
Examples
Section titled “Examples”ndcli org describe
ndcli org describe my-company
ndcli org describe my-company -f jsonorg create
Section titled “org create”Create a new organization.
ndcli org create [name] [flags]Arguments
Section titled “Arguments”| Argument | Required | Description |
|---|---|---|
name | Yes | Organization name (URL-safe identifier) |
| Flag | Type | Description |
|---|---|---|
--display-name | string | Human-readable display name |
--description | string | Organization description |
Examples
Section titled “Examples”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
org delete
Section titled “org delete”Delete an organization.
ndcli org delete [name]Arguments
Section titled “Arguments”| Argument | Required | Description |
|---|---|---|
name | Yes | Organization name to delete |
Examples
Section titled “Examples”ndcli org delete old-organizationorg set-default-ou
Section titled “org set-default-ou”Set the default organizational unit for new devices in the organization.
ndcli org set-default-ou [ou-name]Arguments
Section titled “Arguments”| Argument | Required | Description |
|---|---|---|
ou-name | Yes | Name of the OU to set as default |
Examples
Section titled “Examples”ndcli org set-default-ou staging- New devices will be automatically assigned to this OU when approved
- The OU must exist in the organization
org account
Section titled “org account”Manage organization accounts (members).
org account list
Section titled “org account list”List all accounts (members) in the organization.
ndcli org account listOutput
Section titled “Output”Shows for each account:
- Email address
- Display name
- Role (RO, RW, SU)
- Status (ENABLED, DISABLED)
Examples
Section titled “Examples”ndcli org account listndcli org account list -f jsonorg account role
Section titled “org account role”Set the role for a user account.
ndcli org account role [email] [role]Arguments
Section titled “Arguments”| Argument | Required | Description |
|---|---|---|
email | Yes | User email address |
role | Yes | Role to assign |
Valid Roles
Section titled “Valid Roles”| Role | Aliases | Description |
|---|---|---|
SU | superuser | Full administrative access |
RW | readwrite | Can view and modify resources |
RO | readonly | Can only view resources |
Examples
Section titled “Examples”ndcli org account role user@example.com SU
ndcli org account role user@example.com readonlyorg account enable
Section titled “org account enable”Enable a disabled account.
ndcli org account enable [email]Examples
Section titled “Examples”ndcli org account enable user@example.comorg account disable
Section titled “org account disable”Disable an account, optionally removing it permanently.
ndcli org account disable [email] [flags]| Flag | Type | Default | Description |
|---|---|---|---|
--remove | bool | false | Permanently remove the account |
Examples
Section titled “Examples”ndcli org account disable user@example.com
ndcli org account disable user@example.com --removeorg invite
Section titled “org invite”Manage organization invitations.
org invite list
Section titled “org invite list”List pending invitations for the organization (sent invitations) or for yourself (received invitations).
ndcli org invite listExamples
Section titled “Examples”ndcli org invite listorg invite send
Section titled “org invite send”Send an invitation to join the organization.
ndcli org invite send [email] [flags]Arguments
Section titled “Arguments”| Argument | Required | Description |
|---|---|---|
email | Yes | Email address to invite |
| Flag | Type | Default | Description |
|---|---|---|---|
--role | string | RO | Role to assign: SU, RW, RO |
Examples
Section titled “Examples”ndcli org invite send newuser@example.com
ndcli org invite send admin@example.com --role RWorg invite accept
Section titled “org invite accept”Accept an invitation to join an organization.
ndcli org invite accept [org-name]Arguments
Section titled “Arguments”| Argument | Required | Description |
|---|---|---|
org-name | Yes | Name of the organization to join |
Examples
Section titled “Examples”ndcli org invite accept acme-corporg invite decline
Section titled “org invite decline”Decline an invitation to join an organization.
ndcli org invite decline [org-name]Arguments
Section titled “Arguments”| Argument | Required | Description |
|---|---|---|
org-name | Yes | Name of the organization |
Examples
Section titled “Examples”ndcli org invite decline some-orgorg invite revoke
Section titled “org invite revoke”Revoke a pending invitation (requires superuser privileges).
ndcli org invite revoke [email]Arguments
Section titled “Arguments”| Argument | Required | Description |
|---|---|---|
email | Yes | Email address of the invitee |
Examples
Section titled “Examples”ndcli org invite revoke cancelled-user@example.com