hana-cli
Version:
HANA Developer Command Line Interface
134 lines (86 loc) • 4.04 kB
Markdown
# inspectUser
> Command: `inspectUser`
> Category: **Connection & Auth**
> Status: Production Ready
## Description
Return comprehensive metadata about a database user including user details, parameters, granted roles, and privileges. This command is useful for security audits, troubleshooting access issues, and understanding user configurations.
## Syntax
```bash
hana-cli inspectUser [user] [options]
```
## Aliases
- `iu`
- `user`
- `insUser`
- `inspectuser`
## Command Diagram
```mermaid
graph TD
Start([hana-cli inspectUser]) --> Input[User Parameter]
Input --> Connect[Connect to Database]
Connect --> Query1[Query USERS Table<br/>Get User Details]
Query1 --> Display1[Display User<br/>Basic Information]
Display1 --> Query2[Query USER_PARAMETERS<br/>Get User Parameters]
Query2 --> Display2[Display User<br/>Parameters]
Display2 --> Query3[Query GRANTED_ROLES<br/>Get Assigned Roles]
Query3 --> Display3[Display Granted<br/>Roles]
Display3 --> Query4[Query GRANTED_PRIVILEGES<br/>Get Direct Privileges]
Query4 --> Display4[Display Granted<br/>Privileges]
Display4 --> Complete([Inspection Complete])
style Start fill:#0092d1
style Complete fill:#2ecc71
```
## Parameters
### Positional Arguments
| Parameter | Type | Description |
|-----------|--------|------------------------------|
| `user` | string | Database user name to inspect |
### Options
| Option | Alias | Type | Default | Description |
|----------|-------|--------|---------|------------------------------|
| `--user` | `-u` | string | - | Database user name to inspect |
### Connection Parameters
| Option | Alias | Type | Default | Description |
|-----------|-------|---------|---------|------------------------------------------------------|
| `--admin` | `-a` | boolean | `false` | Connect via admin (default-env-admin.json) |
| `--conn` | - | string | - | Connection filename to override default-env.json |
### Troubleshooting
| Option | Alias | Type | Default | Description |
|---------------------|-----------|---------|---------|----------------------------------------------------------------------------------------------------------|
| `--disableVerbose` | `--quiet` | boolean | `false` | Disable verbose output - removes all extra output that is only helpful to human readable interface |
| `--debug` | `-d` | boolean | `false` | Debug hana-cli itself by adding output of LOTS of intermediate details |
For a complete list of parameters and options, use:
```bash
hana-cli inspectUser --help
```
## Examples
### Basic Usage
```bash
hana-cli inspectUser --user SYSTEM
```
Inspect the SYSTEM user and display comprehensive information including basic user details, parameters, granted roles, and privileges.
### Using Positional Argument
```bash
hana-cli inspectUser DBADMIN
```
Inspect a user by providing the username as a positional argument.
### Inspect Current User
```bash
hana-cli inspectUser --user $(whoami)
```
Inspect the currently connected user's configuration.
## Output Sections
The command displays four sections of information:
1. **User Basic Information**: USER_NAME, USER_ID, USERGROUP_NAME, CREATE_TIME, etc.
2. **User Parameters**: Configuration parameters specific to the user
3. **Granted Roles**: All roles assigned to the user with grantor information
4. **Granted Privileges**: Direct privileges assigned to the user
For a complete list of parameters and options, use:
```bash
hana-cli inspectUser --help
```
## Related Commands
See the [Commands Reference](../all-commands.md) for other commands in this category.
## See Also
- [Category: Connection & Auth](..)
- [All Commands A-Z](../all-commands.md)