# acl

Access Control List management

## Usage

```bash
apolo acl [OPTIONS] COMMAND [ARGS]...
```

Access Control List management.

**Commands:**

| Usage                         | Description                          |
| ----------------------------- | ------------------------------------ |
| [*add-role*](#add-role)       | Add new role                         |
| [*grant*](#grant)             | Shares resource with another user    |
| [*list-roles*](#list-roles)   | List roles                           |
| [*ls*](#ls)                   | List shared resources                |
| [*remove-role*](#remove-role) | Remove existing role                 |
| [*revoke*](#revoke)           | Revoke user access from another user |

### add-role

Add new role

#### Usage

```bash
apolo acl add-role [OPTIONS] ROLE_NAME
```

Add new role.

#### Examples

```bash
$ apolo acl add-role mycompany/subdivision
```

#### Options

| Name     | Description                 |
| -------- | --------------------------- |
| *--help* | Show this message and exit. |

### grant

Shares resource with another user

#### Usage

```bash
apolo acl grant [OPTIONS] URI USER {read|write|manage}
```

Shares resource with another user.

`URI` shared resource.

`USER` username to share resource with.

`PERMISSION` sharing access right: read, write, or manage.

#### Examples

```bash
$ apolo acl grant storage:///sample_data/ alice manage
$ apolo acl grant image:resnet50 bob read
$ apolo acl grant job:///my_job_id alice write
```

#### Options

| Name     | Description                 |
| -------- | --------------------------- |
| *--help* | Show this message and exit. |

### list-roles

List roles

#### Usage

```bash
apolo acl list-roles [OPTIONS]
```

List roles.

#### Examples

```bash
$ apolo acl list-roles
$ apolo acl list-roles username/projects
```

#### Options

| Name      | Description                            |
| --------- | -------------------------------------- |
| *--help*  | Show this message and exit.            |
| *-u TEXT* | Fetch roles of specified user or role. |

### ls

List shared resources

#### Usage

```bash
apolo acl ls [OPTIONS] [URI]
```

List shared resources.

The command displays a list of resources shared BY current user (default).

To display a list of resources shared `WITH` current user apply --shared option.

#### Examples

```bash
$ apolo acl list
$ apolo acl list storage://
$ apolo acl list --shared
$ apolo acl list --shared image://
```

#### Options

| Name         | Description                              |
| ------------ | ---------------------------------------- |
| *--help*     | Show this message and exit.              |
| *--full-uri* | Output full URI.                         |
| *--shared*   | Output the resources shared by the user. |
| *-u TEXT*    | Use specified user or role.              |

### remove-role

Remove existing role

#### Usage

```bash
apolo acl remove-role [OPTIONS] ROLE_NAME
```

Remove existing role.

#### Examples

```bash
$ apolo acl remove-role mycompany/subdivision
```

#### Options

| Name     | Description                 |
| -------- | --------------------------- |
| *--help* | Show this message and exit. |

### revoke

Revoke user access from another user

#### Usage

```bash
apolo acl revoke [OPTIONS] URI USER
```

Revoke user access from another user.

`URI` previously shared resource to revoke.

`USER` to revoke `URI` resource from.

#### Examples

```bash
$ apolo acl revoke storage:///sample_data/ alice
$ apolo acl revoke image:resnet50 bob
$ apolo acl revoke job:///my_job_id alice
```

#### Options

| Name     | Description                 |
| -------- | --------------------------- |
| *--help* | Show this message and exit. |