Skip to content

Commit

Permalink
Update docs to include CLI managing users (unitycatalog#530)
Browse files Browse the repository at this point in the history
**PR Checklist**

- [X] A description of the changes is added to the description of this
PR.
- [ ] If there is a related issue, make sure it is linked to this PR.
- [ ] If you've fixed a bug or added code that should be tested, add
tests!
- [ ] If you've added or modified a feature, documentation in `docs` is
updated

**Description of changes**
- Fixed image loc in UI doc
- Added managing users to CLI doc

<!-- Please state what you've changed and how it might affect the users.
-->

Signed-off-by: Vikrant Puppala <vikrant.puppala@databricks.com>
  • Loading branch information
dennyglee authored and vikrantpuppala committed Oct 1, 2024
1 parent 865d6fb commit 699fe43
Show file tree
Hide file tree
Showing 2 changed files with 107 additions and 2 deletions.
105 changes: 105 additions & 0 deletions docs/usage/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -444,3 +444,108 @@ The CLI can be configured to talk to Databricks Unity Catalog by one of the foll

Each parameter can be configured either from the CLI or the configuration file, independently of each other.
The CLI will prioritize the values provided from the CLI over the configuration file.

!!! feedback "Different look for users CLI commands"

We're trying out a different look for the CLI commands - which do you prefer - the format above this or the format below? Chime in UC GitHub discussion [529](https://github.com/unitycatalog/unitycatalog/discussions/529) and let us know!


## 8. Manage Users

This section outlines the usage of the `bin/uc` script for managing users within UC.
The script supports various operations such as creating, getting, updating, listing, and deleting users.

### 8.1 Create User

```bash title="Usage"
bin/uc create [options]
```

*Required Params:*

-- name: The name of the entity.
-- email : The email address for the user

*Optional Params:*

-- server: UC Server to connect to. Default is reference server.
-- auth_token: PAT token to authorize uc requests.
-- external_id: The identity provider's id for the user
-- output: To indicate CLI output format preference. Supported values are json and jsonPretty.


### 8.2 Delete User

```bash title="Usage"
bin/uc user delete [options]
```

*Required Params:*

--id The unique id of the user

*Optional Params:*

--server UC Server to connect to. Default is reference server.
--auth_token PAT token to authorize uc requests.
--output To indicate CLI output format preference. Supported values are json and jsonPretty.


### 8.3 Get User

```bash title="Usage"
bin/uc user get [options]
```

*Required Params:*

--id The unique id of the user

*Optional Params:*

--server UC Server to connect to. Default is reference server.
--auth_token PAT token to authorize uc requests.
--output To indicate CLI output format preference. Supported values are json and jsonPretty.


### 8.4 List Users

```bash title="Usage"
bin/uc user list [options]
```

*Required Params:*

None

*Optional Params:*

--server UC Server to connect to. Default is reference server.
--auth_token PAT token to authorize uc requests.
--output To indicate CLI output format preference. Supported values are json and jsonPretty.
--filter Query by which the results have to be filtered
--start_index Specifies the index (starting at 1) of the first result.
--count Desired number of results per page


### 8.5 Update User

```bash title="Usage"
bin/uc user update [options]
```


*Required Params:*

--id The unique id of the user


*Optional Params:*

--server UC Server to connect to. Default is reference server.
--auth_token PAT token to authorize uc requests.
--output To indicate CLI output format preference. Supported values are json and jsonPretty.
--name The name of the entity.
--external_id The identity provider's id for the user
--email The email address for the user

4 changes: 2 additions & 2 deletions docs/usage/ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

The Unity Catalog UI allows you to interact with a Unity Catalog server to view or create data and AI assets.

## Start Unity Catalog UI locally

![UC UI](../assets/images/ui/uc-ui-expanded.png)

## Start Unity Catalog UI locally

To use the Unity Catalog UI, start a new terminal and ensure you have already started the UC server (e.g., `./bin/start-uc-server`)

!!! warning "Prerequisites"
Expand Down

0 comments on commit 699fe43

Please sign in to comment.