Import Kong Identity resources.
kongctl provides the following tools for importing Kong Identity data:
|
Command |
Description |
|---|---|
| kongctl import identity org-chart | Upload a complete organization-chart CSV and privately capture its report. |
Usage:
kongctl import identity [flags]
kongctl import identity [command]
Aliases:
identity, id
Available Commands:
org-chart Upload a complete organization-chart CSV and privately capture its report
Flags:
--base-url string Base URL for Konnect API requests.
- Config path: [ konnect.base-url ]
--color-theme string Configures the CLI UI/theme (prompt, tables, TUI elements).
- Config path: [ color-theme ]
- Examples : [ auto, 0_x_96_f, 12_bit_rainbow, 13_th_floor, 3024_day ]
- List : [ kongctl list themes ] (default "auto")
--config-file string Path to the configuration file to load.
- Environment variable: KONGCTL_CONFIG_FILE (overridden by this flag)
- Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
-h, --help help for identity
--log-file string Write execution logs to the specified file instead of STDERR.
- Config path: [ log-file ]
--log-level string Configures the logging level. Execution logs are written to STDERR.
- Config path: [ log-level ]
- Allowed : [ trace|debug|info|warn|error ] (default "error")
--no-telemetry Disable telemetry for this command invocation. Overrides config and env.
- Config path: [ telemetry.enabled ]
- Env var : [ KONGCTL_NO_TELEMETRY ]
- Default : [ false ]
--no-trunc Preserve full cell widths in static text tables beyond terminal width.
Does not change column selection, UUID formatting, or explicit string slices.
- Config path: [ text.no-trunc ]
- Default : [ false ]
-o, --output string Configures the format of data written to STDOUT.
- Config path: [ output ]
- Allowed : [ json|yaml|text ] (default "text")
--pat string Konnect Personal Access Token (PAT).
- Config path: [ konnect.pat ]
-p, --profile string Specify the profile to use for this command. (default "default")
--region string Konnect region identifier (for example eu).
- Config path: [ konnect.region ]
--text-id-format string Configure UUID rendering in static text-table ID columns.
- Config path: [ text.id-format ]
- Allowed : [ compact|full ]
- Default : [ compact ]
--text-layout string Configure static text-table column selection.
- Config path: [ text.layout ]
- Allowed : [ compact|auto|wide ]
- Default : [ compact ]
Use "kongctl import identity [command] --help" for more information about a command.
Upload a complete organization-chart CSV and privately capture its report.
Usage:
kongctl import identity org-chart [flags]
Aliases:
org-chart, org-charts
Examples:
# Preview the complete roster without changing users or teams
kongctl import id org-chart \
--file org-chart.csv \
--dry-run \
--report-output-dir ./import-reports
# Apply the roster after reviewing the preview report
kongctl import id org-chart \
--file org-chart.csv \
--execute \
--report-output-dir ./import-reports
Flags:
--base-url string Base URL for Konnect API requests.
- Config path: [ konnect.base-url ]
--color-theme string Configures the CLI UI/theme (prompt, tables, TUI elements).
- Config path: [ color-theme ]
- Examples : [ auto, 0_x_96_f, 12_bit_rainbow, 13_th_floor, 3024_day ]
- List : [ kongctl list themes ] (default "auto")
--config-file string Path to the configuration file to load.
- Environment variable: KONGCTL_CONFIG_FILE (overridden by this flag)
- Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
--directory-id string Parent directory UUID (overrides the default name)
--directory-name string Exact parent directory name.
- Default: [ default ]
--dry-run Validate/report without changing the hierarchy
--execute Apply the complete file, including import-owned departures
-f, --file string CSV file containing all users and their managers (required)
-h, --help help for org-chart
--log-file string Write execution logs to the specified file instead of STDERR.
- Config path: [ log-file ]
--log-level string Configures the logging level. Execution logs are written to STDERR.
- Config path: [ log-level ]
- Allowed : [ trace|debug|info|warn|error ] (default "error")
--no-telemetry Disable telemetry for this command invocation. Overrides config and env.
- Config path: [ telemetry.enabled ]
- Env var : [ KONGCTL_NO_TELEMETRY ]
- Default : [ false ]
--no-trunc Preserve full cell widths in static text tables beyond terminal width.
Does not change column selection, UUID formatting, or explicit string slices.
- Config path: [ text.no-trunc ]
- Default : [ false ]
-o, --output string Configures the format of data written to STDOUT.
- Config path: [ output ]
- Allowed : [ json|yaml|text ] (default "text")
--pat string Konnect Personal Access Token (PAT).
- Config path: [ konnect.pat ]
-p, --profile string Specify the profile to use for this command. (default "default")
--region string Konnect region identifier (for example eu).
- Config path: [ konnect.region ]
--report-output-dir string Directory for uniquely named private JSON reports (required; created if needed)
--text-id-format string Configure UUID rendering in static text-table ID columns.
- Config path: [ text.id-format ]
- Allowed : [ compact|full ]
- Default : [ compact ]
--text-layout string Configure static text-table column selection.
- Config path: [ text.layout ]
- Allowed : [ compact|auto|wide ]
- Default : [ compact ]