Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
This page details the immuta datasource
command, its subcommands and arguments, and the workflow for creating, renaming, and deleting data sources.
immuta datasource
This command allows you to list, save, delete, and rename data sources in your instance of Immuta. The table below illustrates subcommands and arguments.
Use these options to get more details about the datasource
command or any of its subcommands:
-h
--help
immuta datasource save
Add your remote database's connection information in a valid YAML file for the V2 API. Additional payload examples for creating data sources can be found here:
Run immuta datasource save <filepath> [--wait int] [--dryRun]
, referencing the file you just created. The options you can specify include
-d
or --dryRun
: No updates will actually be made to the data source(s).
-h
or --help
: Get more information about the command.
-w
or --wait int
: Specify how long to wait for data source creation.
The following example illustrates a user saving an updated datasourceInfo.yaml
file, first as a dry run and then by specifying that the data sources wait 5 seconds to be created.
immuta datasource rename
Run immuta datasource list keys
to view a list of data source connection keys. Options you can specify include
-h
or --help
: Get more information about the command.
-v
or --verbose
: Print response as JSON.
To rename one of your data source connection keys, run immuta datasource rename <old connection key> <new connection key>
. You can include the -h
or --help
options to get more information about this command.
The following example illustrates a user renaming a data source connection key to demonstration
.
immuta datasource delete
This command will delete all data sources for the connection key you specify.
Run immuta datasource list keys
to view a list of data source connection keys. Options you can specify include
-h
or --help
: Get more information about the command.
-v
or --verbose
: Print response as JSON.
Opt to view a list of the data sources in this connection key by running immuta datasource list sources <connection key>
.
Run immuta datasource delete <connection key> [--dryRun]
to delete all of these data sources. Options you can specify include
-d
or --dryRun
: No updates will actually be made.
-h
or --help
: Get more information about the command.
The following example illustrates a user deleting the demonstration
connection key and all its data sources.
This page details the immuta
command, its subcommands and arguments, and the workflow for cloning a tenant and using the Immuta API.
immuta
This command allows you to manage your Immuta tenant by creating data sources, projects, policies, and purposes. The table below illustrates the immuta
subcommands and arguments.
To view a list of the commands available in your current Immuta CLI version, run immuta
with no additional arguments.
Options you can specify with the immuta
command include
--config string
: Specify the configuration file name and where it will be saved. (The default is $HOME/.immutacfg.yaml
.)
-h
or --help
: Get more information about the command.
-p
or --profile string
: Specify the profile for what tenant or API the CLI will use.
immuta clone
You need the GOVERNANCE
permission in Immuta to run this command.
If you have an Immuta tenant that was set up without using the API, you can use the immuta clone
command to save all your data sources, projects, policies, and purposes as payloads:
This command will create valid V2 API YAML files for all your data sources, projects, policies, and purposes. Within these files, database passwords and user files (such as a BigQuery auth file) will be removed; instead passwords will appear as {{EnvVar "dbPass"}}
. The CLI will then read the environment variable dbPass
to fill in the password if you use the cloned payload to create or update a data source. File contents will appear as {{ReadFile "<filePath>"}}
, and then the CLI will read the file at the path and replace the value when commands are run.
--force
: Overwrite existing output directory targets. If this flag is omitted, you will receive an error when the output directory exists and is not empty.
-h
or --help
: Get details about the command.
Tags for data sources and projects are not returned.
Data sources will not have the sources
field, so if these payloads are used in create
commands, all possible tables will be created as data sources.
immuta api
This command makes an authenticated HTTP(s) request to the Immuta API and prints the response. The default HTTP request method is GET
, but POST
is used if any parameters were added. You can override the method with --method
:
-b
, --body string
: Unmodified string to be sent as payload body.
-d
, --data key=value
: Add a typed parameter in key=value
format. The --data
flag behaves like --raw-data
, with type conversion based on the format of the value. Literal values, true
, false
, null
, and integers are converted to appropriate JSON types. This will be sent in as the request payload.
--data-raw key=value
: Add a string parameter in key=value
format. The --data
flag behaves like --raw-data
, with type conversion based on the format of the value. Literal values, true
, false
, null
, and integers are converted to appropriate JSON types. This will be sent in as the request payload.
-H
, --header key:value
: Add an HTTP request header in key:value
format.
-h
, --help
: Get details about the command.
--input <filepath>
: A raw request body may be passed from the outside via the file specified to use as body for the HTTP request. Pass in '-' for standard input.
-X
, --method string
: The HTTP method for the request (default GET
).
-P
, --path-param key=value
: Add a string parameter in key=value format. Will replace {key}
in the url with value
.
-q
, --query key=value
: Add a string parameter in key=value format. The key value pairs are serialized into URL query parameters.
-t
, --outputTemplate string
: Format the response using a Go template. The provided Go template is rendered using the JSON data as input. For the syntax of Go templates, see this document.
The documentation below provides descriptions and examples of immuta api
options.
immuta sdd classifier
This command allows you to manage identifiers that will apply tags to data that matches the criteria you specify during SDD. The table below illustrates subcommands and arguments.
Use these options to get more details about the sdd classifier
command or any of its subcommands:
-h
--help
Save your identifier to a valid YAML or JSON file using these attributes.
Examples are provided below.
Run immuta sdd classifier create <filepath> [flags]
, referencing the file you just created. The options you can specify include
-h
or --help
: Get more information about the command.
-o
or --output json | yaml
: Specify the output format.
--outputTemplate string
: Format the response using a Go template.
Run immuta sdd classifier get <classifierName> [flags]
, specifying the name of the identifier you would like to get. Options you can specify include
-h
or --help
: Get more information about the command.
-o
or --output json | yaml
: Specify the output format.
--outputTemplate string
: Format the response using a Go template.
The example below illustrates a user getting an identifier called ACCOUNT_NUMBER_IDENTIFIER.
Run immuta sdd classifier search [string] [flags]
to list all identifiers or search identifiers by name. Options you can specify include
-h
, --help
: Help for search.
--limit int
The search limit for pagination (default 25).
--offset int
: The search offset for pagination.
--order asc | desc
: The sort order.
-o
, --output json | yaml
: The output format.
--outputTemplate string
: Format the response using a Go template.
-s
, --sort id | name | displayName | type | createdAt | updatedAt
: Field to sort by.
--type regex | columnNameRegex | dictionary | builtIn
: Limit results to the specified criteria type.
The example below illustrates a user searching all identifiers containing account
.
Update your identifier in a valid YAML or JSON file using these attributes:
Run immuta sdd classifier update <classifierName> <filepath> [flags]
, referencing the file you just updated. The options you can specify include
-h
or --help
: Get more information about the command.
-o
or --output json | yaml
: Specify the output format.
--outputTemplate string
: Format the response using a Go template.
The example below illustrates a user updating an identifier named ACCOUNT_NUMBER_IDENTIFIER.
Run immuta sdd classifier delete <classifierName> [flags]
to delete the identifier. The options you can specify include