Create and manage Intake users
Prerequisites
Section titled “Prerequisites”To begin creating and managing your Intakes via the STACKIT CLI, ensure you have the following in place:
- You have a STACKIT customer account: Create a customer Account
- You have a STACKIT user account: Create a user account
- You have a STACKIT project: Create a project
- You have installed the STACKIT CLI on your system: User Guide
- You have configured Dremio and possess the necessary Dremio Personal Access Token (PAT), Catalog URI, Warehouse name, and Token Endpoint URL: Configure Dremio for STACKIT Intake integration
- You have created an Intake Runner: Create and Manage and Intake Runners
- You have created an Intake: Create and Manage Intakes
Create an Intake user
Section titled “Create an Intake user”When creating a user, you must define its type and provide a strong password.
User types
Section titled “User types”| Type | Purpose | Permissions |
|---|---|---|
| intake | For data producers (applications/services) to send messages to the Intake | Write-only access to the Intake topic. |
| dead-letter | For debugging purposes to read failed messages. | Read-only access to the Intake’s Dead Letter Queue (DLQ) topic. |
Password Requirements
Section titled “Password Requirements”Passwords are not stored in a retrievable format. Clients are expected to keep track of the passwords on their own. For security, STACKIT enforces passwords to be strong: at least 12 characters, including lower/upper case, numbers, and special characters.
| Flag | Description | Options | Default | Optional |
|---|---|---|---|---|
| intake-id | the ID of the Intake into which the User will be deployed | UUID of the Intake | ||
| display-name | a human-readable name for the Intake | String, not longer than 32 characters | ||
| password | the password for the user | String, at least 12 characters, upper / lower case, numbers, special characters | ||
| type | the type of the user | One of:<br>• intake<br>• dead-letter | ||
| description | a description of the user’s purpose | String, not longer than 1024 characters | "" | x |
| labels | labels in key=value format. Allows one to classify the purpose of the Intake user | key=value format, separated by commas. Example: “key1=value1,key2=value2” | [] | x |
Execute the Creation Command
Section titled “Execute the Creation Command”To create an Intake user, execute the following command:
stackit beta Intake user create --intake-id <INTAKE_ID> --display-name <NAME> --password <PASSWORD> --type <TYPE> --description <DESCRIPTION> --labels <LABELS>The response to this command should look like this:
Created Intake user for Intake "17802315-32c2-48ce-a33d-3043d8aec89b". User ID: e9e65d48-0d4e-44f3-8dc0-6091b5381e0bExample
Section titled “Example”stackit beta Intake user create --intake-id 17802315-32c2-48ce-a33d-3043d8aec89b \--display-name iot-producer \--password 'MyVerySecretPassword!2025!ProdUser1' \--type intakeView an Intake user
Section titled “View an Intake user”You can check the status and details of any specific Intake user.
| Argument | Description |
|---|---|
| USER_ID | the ID of the Intake user we are interested in. |
| Flag | Description |
|---|---|
| intake-id | the ID of the Intake the Intake user belongs to |
Execute the View Command
Section titled “Execute the View Command”stackit beta Intake user describe <USER_ID> --intake-id <INTAKE_ID>This will result in an output like the following:
ATTRIBUTE │ VALUE──────────────────────────┼──────────────────────────────────────────────────ID │ e9e65d48-0d4e-44f3-8dc0-6091b5381e0bName │ producerState │ activeCreated │ 2025-10-16 15:58:58 +0000 UTCLabels │ <nil>Type │ intakeUsername │ intake-user-e9e65d48-0d4e-44f3-8dc0-6091b5381e0b──────────────────────────┼──────────────────────────────────────────────────Java Client Config │──────────────────────────┼──────────────────────────────────────────────────librdkafka Client Config │List all Intake users
Section titled “List all Intake users”To list all Intake users for an Intake:
| Flag | Description |
|---|---|
| intake-id | the ID of the Intake in whose users we are interested in |
stackit beta Intake user list --intake-id <INTAKE_ID>This will result in output like the following:
ID │ NAME │ STATE │ TYPE │ USERNAME──────────────────────────────────────┼──────────┼────────┼────────┼──────────────────────────────────────────────────e9e65d48-0d4e-44f3-8dc0-6091b5381e0b │ producer │ active │ intake │ intake-user-e9e65d48-0d4e-44f3-8dc0-6091b5381e0bUpdate an Intake user
Section titled “Update an Intake user”You can update an Intake user’s properties. For example, you can change a user’s password.
| Argument | Description |
|---|---|
| USER_ID | the ID of the Intake user we are interested in. |
| Flag | Description | Options |
|---|---|---|
| intake-id | the ID of the Intake to which the user belongs | UUID of the Intake |
| display-name | a human-readable name for the Intake | String, not longer than 32 characters |
| password | the password for the user | String, at least 12 characters, upper / lower case, numbers, special characters |
| description | a description of the user’s purpose | String, not longer than 1024 characters |
| labels | labels in key=value format. Allows one to classify the purpose of the Intake user | key=value format, separated by commas. Example: “key1=value1,key2=value2” |
Execute the update command
Section titled “Execute the update command”To update your Intake user, execute the command providing the ID of the Intake user and the relevant flags:
stackit beta Intake user update <USER_ID> --intake-id <INTAKE_ID> --display-name <NAME> --password <PASSWORD> --description <DESCRIPTION> --labels <LABELS>When the update command has been sent, the CLI will return respond with a text like this:
Update Request for Intake user "e9e65d48-0d4e-44f3-8dc0-6091b5381e0b" sent successfully.Examples
Section titled “Examples”Change the labels of an Intake user:
stackit beta Intake user update e9e65d48-0d4e-44f3-8dc0-6091b5381e0b --intake-id 17802315-32c2-48ce-a33d-3043d8aec89b --labels "dept=billing,stage=test"Refresh the password of an Intake user:
stackit beta intake update 9e65d48-0d4e-44f3-8dc0-6091b5381e0b --intake-id 17802315-32c2-48ce-a33d-3043d8aec89b --password "SUPER_SECRET_PASSWORD"Delete an Intake user
Section titled “Delete an Intake user”Deleting an Intake user immediately revokes the associated application’s access to the Intake stream:
| Argument | Description |
|---|---|
| USER_ID | the ID of the Intake user we are interested in. |
| Flag | Description |
|---|---|
| intake-id | the ID of the Intake the Intake user belongs to |
Execute the Delete Command
Section titled “Execute the Delete Command”stackit beta Intake user delete <USER_ID> --intake-id <INTAKE_ID>Example
Section titled “Example”stackit beta Intake user delete --intake-id 17802315-32c2-48ce-a33d-3043d8aec89b e9e65d48-0d4e-44f3-8dc0-6091b5381e0b