Skip to main content
View and manage organizations. Organizations are the top-level grouping for accounts, providing centralized management of billing, policies, and access control.

Usage

idyl org

Aliases

  • orgs
  • organization
  • organizations

Commands

CommandDescription
idyl org createCreate a new organization
idyl org deleteDelete an organization
idyl org editEdit an organization
idyl org getGet organization details or list all organizations
idyl org inviteManage organization invitations
idyl org leaveLeave the current organization
idyl org ouManage organizational units

Inherited flags

FlagDescription
-a <string>, --account-id <string>Account ID to use (overrides context)
-c <string>, --context <string>Use specific context
--homedir <string>Override config directory (default: ~/.idyl)
-n <string>, --namespace <string>Namespace to use
-o <string>, --output <string>Output format (json|yaml)
-p <string>, --profile <string>Override profile
--realm <string>Override realm
--subnet <string>Override context subnet for this command

Examples

# List organizations you can access
idyl org list

# Get details of a specific organization (by ID)
idyl org get 593184027116

# Create a new organization
idyl org create --name "My Org" --billing-email [email protected]

# Edit an organization
idyl org edit 593184027116 --set-name "My Organization"

# Delete an organization
idyl org delete 593184027116

Subcommand reference

idyl org create

Create a new organization. The organization name is a display label, not a persistent identifier. After creation, use the returned ID for all subsequent operations.

Usage

idyl org create [flags]

Flags

FlagDescription
--billing-email <string>Billing email address for the organization
--name <string>Required. Organization name
-o <string>, --output <string>Output format: table, json, yaml Default: table.

Examples

# Create an organization
idyl org create --name "My Company"

# Create an organization with billing email
idyl org create --name "My Company" --billing-email [email protected]

idyl org delete

Delete an organization by ID. This action is irreversible and will remove the organization and all associated resources. Requires admin access to the organization. You will be prompted for confirmation unless the —yes flag is provided.

Usage

idyl org delete <id> [flags]

Flags

FlagDescription
-y, --yesSkip confirmation prompts

Examples

# Delete an organization (with confirmation)
idyl org delete 593184027116

# Delete without confirmation
idyl org delete 593184027116 --yes

idyl org edit

Edit an organization’s settings. Only the specified flags are updated; other settings remain unchanged. Requires admin access to the organization.

Usage

idyl org edit <id> [flags]

Flags

FlagDescription
-o <string>, --output <string>Output format: table, json, yaml Default: table.
--set-billing-email <string>Set the organization billing email
--set-name <string>Set the organization display name

Examples

# Update display name
idyl org edit 593184027116 --set-name "My Company Inc."

# Update billing email
idyl org edit 593184027116 --set-billing-email [email protected]

# Update both
idyl org edit 593184027116 --set-name "My Company Inc." --set-billing-email [email protected]

idyl org get

Get details of a specific organization, or list all organizations you can access. With no arguments, lists all accessible organizations. With an ID argument, gets details of that specific organization.

Usage

idyl org get [id] [flags]

Aliases

  • list
  • ls

Flags

FlagDescription
--limit <int>Maximum number of organizations to list Default: 20.
--offset <int>Number of organizations to skip Default: 0.
-o <string>, --output <string>Output format: table, json, yaml Default: table.

Examples

# List organizations you can access
idyl org get

# Get organization by ID
idyl org get 593184027116

# Get organization in JSON format
idyl org get 593184027116 -o json

idyl org invite

View and manage invitations to join organizations. This command supports both organization-scoped operations (for admins) and account-scoped operations (for users receiving invitations). Organization-scoped commands (require org context):
  • get: Get invitation details or list all pending invitations
  • send: Send a new invitation to join the organization
Account-scoped commands (for the current user):
  • accept: Accept a pending invitation
  • decline: Decline a pending invitation

Usage

idyl org invite

Aliases

  • invites
  • invitation
  • invitations

Commands

CommandDescription
idyl org invite acceptAccept an invitation to join an organization
idyl org invite declineDecline an invitation to join an organization
idyl org invite getGet invitation details or list all invitations
idyl org invite sendSend an invitation to join the organization

Examples

# List invitations sent by the organization (admin)
idyl org invite list

# Get a specific invitation
idyl org invite get <invitation-id>

# Send an invitation to a user
idyl org invite send [email protected]

# Accept an invitation
idyl org invite accept <invitation-id>

# Decline an invitation
idyl org invite decline <invitation-id>

idyl org invite accept

Accept a pending invitation to join an organization. After accepting, you will become a member of the organization and can switch to that account context using ‘idyl use’.

Usage

idyl org invite accept <id>

Examples

# Accept an invitation
idyl org invite accept 12345678-1234-1234-1234-123456789012

idyl org invite decline

Decline a pending invitation to join an organization. Once declined, the invitation cannot be accepted. The organization administrator may send a new invitation if needed.

Usage

idyl org invite decline <id>

Examples

# Decline an invitation
idyl org invite decline 12345678-1234-1234-1234-123456789012

idyl org invite get

Get details of a specific invitation, or list all invitations. With no arguments, lists all invitations sent by the current organization. With an ID argument, gets details of that specific invitation.

Usage

idyl org invite get [id] [flags]

Aliases

  • list
  • ls

Flags

FlagDescription
-o <string>, --output <string>Output format: table, json, yaml Default: table.

Examples

# List all invitations
idyl org invite get

# Get a specific invitation
idyl org invite get 550e8400-e29b-41d4-a716-446655440000

# List invitations in JSON format
idyl org invite get -o json

idyl org invite send

Send an invitation to a user to join the current organization. This command requires an organization context. The invitee will receive an invitation that they can accept or decline.

Usage

idyl org invite send <email> [flags]

Flags

FlagDescription
--ou-id <string>Target organizational unit ID for the invitee

Examples

# Send an invitation
idyl org invite send [email protected]

# Send an invitation to a specific OU
idyl org invite send [email protected] --ou-id 550000000001

idyl org leave

Leave the organization that the current account belongs to. This action removes your account from the organization. You will lose access to organization resources and will need a new invitation to rejoin. This command requires confirmation unless —yes is specified.

Usage

idyl org leave [flags]

Flags

FlagDescription
-y, --yesSkip confirmation prompts

Examples

# Leave the current organization (with confirmation)
idyl org leave

# Leave without confirmation
idyl org leave --yes

idyl org ou

View and manage organizational units (OUs) within your organization. Organizational units provide a hierarchical structure for organizing accounts within an organization. OUs can contain other OUs and accounts. This command requires an organization context. If your current account is not part of an organization, these commands will not work.

Usage

idyl org ou

Aliases

  • ous

Commands

CommandDescription
idyl org ou createCreate a new organizational unit
idyl org ou deleteDelete an organizational unit
idyl org ou editEdit an organizational unit
idyl org ou getGet organizational unit details or list all OUs
idyl org ou moveMove an organizational unit to a new parent

Examples

# List all OUs in the current organization
idyl org ou list

# Create a new OU
idyl org ou create --name engineering --description "Engineering team"

# Get details of an OU by ID
idyl org ou get 550000000001

# Edit an OU
idyl org ou edit 550000000001 --set-name "Platform Engineering"

# Move an OU to a new parent
idyl org ou move 550000000001 --set-parent-id 660000000001

# Delete an OU
idyl org ou delete 550000000001

idyl org ou create

Create a new organizational unit in the current organization. The OU name is a display label. You can optionally specify a description and a parent OU ID.

Usage

idyl org ou create [flags]

Flags

FlagDescription
--description <string>Description of the organizational unit
--name <string>Required. Organizational unit name
-o <string>, --output <string>Output format: table, json, yaml Default: table.
--parent-id <string>Parent OU ID (for creating nested OUs)

Examples

# Create a top-level OU
idyl org ou create --name engineering

# Create an OU with a description
idyl org ou create --name engineering --description "Engineering department"

# Create a nested OU under an existing parent (by ID)
idyl org ou create --name platform --parent-id 550000000001

idyl org ou delete

Delete an organizational unit by ID. This action is irreversible and will remove the OU. The OU must be empty (no child OUs or accounts) before it can be deleted. You will be prompted for confirmation unless the —yes flag is provided.

Usage

idyl org ou delete <id> [flags]

Flags

FlagDescription
-y, --yesSkip confirmation prompts

Examples

# Delete an OU (with confirmation)
idyl org ou delete 550000000001

# Delete without confirmation
idyl org ou delete 550000000001 --yes

idyl org ou edit

Edit an organizational unit’s settings. Only the specified flags are updated; other settings remain unchanged.

Usage

idyl org ou edit <id> [flags]

Flags

FlagDescription
-o <string>, --output <string>Output format: table, json, yaml Default: table.
--set-description <string>Set the OU description
--set-name <string>Set the OU display name

Examples

# Update an OU's display name
idyl org ou edit 550000000001 --set-name "Platform Engineering"

# Update an OU's description
idyl org ou edit 550000000001 --set-description "Platform team"

# Update both
idyl org ou edit 550000000001 --set-name "Platform" --set-description "Platform team"

idyl org ou get

Get details of a specific organizational unit, or list all OUs. With no arguments, lists all organizational units in the current organization. With an ID argument, gets details of that specific OU.

Usage

idyl org ou get [id] [flags]

Aliases

  • list
  • ls

Flags

FlagDescription
-o <string>, --output <string>Output format: table, json, yaml Default: table.

Examples

# List all OUs
idyl org ou get

# Get an OU by ID
idyl org ou get 550000000001

# Get OU in JSON format
idyl org ou get 550000000001 -o json

idyl org ou move

Move an organizational unit to a new parent OU. This changes the hierarchical position of the OU within the organization. Use —set-parent-id to specify the new parent OU, or —to-root to move the OU to the root level.

Usage

idyl org ou move <id> [flags]

Flags

FlagDescription
-o <string>, --output <string>Output format: table, json, yaml Default: table.
--set-parent-id <string>New parent OU ID
--to-rootMove OU to root level (no parent)

Examples

# Move an OU to a different parent
idyl org ou move 550000000001 --set-parent-id 660000000001

# Move an OU to the root level
idyl org ou move 550000000001 --to-root