# access
URL: https://openship.io/docs/cli/reference/access.md

Commands, arguments, and options for openship access.

See the [workflow guide](/docs/cli/access) for examples. Global flags such as `--json` go before the command; see [global options](/docs/cli/reference#global-options).

## openship access

Manage workspaces, members, invitations and resource grants

```text
openship access [options] [command]
```

| Subcommand | Purpose |
| --- | --- |
| [`workspaces`](/docs/cli/reference/access#openship-access-workspaces) | List accessible workspaces and whether this credential can select an organization |
| [`organization`](/docs/cli/reference/access#openship-access-organization) | Show the current organization and member count |
| [`create-team [options] <name>`](/docs/cli/reference/access#openship-access-create-team) | Create a team workspace; select its ID with the global --organization option |
| [`resources [options] <type>`](/docs/cli/reference/access#openship-access-resources) | List resources available for permission grants |
| [`members`](/docs/cli/reference/access#openship-access-members) | Manage membership in the selected workspace |
| [`grants`](/docs/cli/reference/access#openship-access-grants) | Manage per-resource access grants |
| [`invitations`](/docs/cli/reference/access/invitations#openship-access-invitations) | Manage workspace invitations |

## openship access create-team

Create a team workspace; select its ID with the global --organization option

```text
openship access create-team [options] <name>
```

| Argument | Meaning |
| --- | --- |
| `name` | Workspace name |

| Option | Meaning |
| --- | --- |
| `--slug <slug>` | Workspace slug |

## openship access grants

Manage per-resource access grants

```text
openship access grants [options] [command]
```

| Subcommand | Purpose |
| --- | --- |
| [`list <user>`](/docs/cli/reference/access#openship-access-grants-list) | List a user's resource grants |
| [`set <file>`](/docs/cli/reference/access#openship-access-grants-set) | Create or update one resource grant |
| [`replace [options] <file>`](/docs/cli/reference/access#openship-access-grants-replace) | Replace a user's complete resource grant set |
| [`remove <id>`](/docs/cli/reference/access#openship-access-grants-remove) | Revoke one resource grant |

## openship access grants list

List a user's resource grants

```text
openship access grants list [options] <user>
```

| Argument | Meaning |
| --- | --- |
| `user` | User ID |

## openship access grants remove

Revoke one resource grant

```text
openship access grants remove [options] <id>
```

| Argument | Meaning |
| --- | --- |
| `id` | Grant ID |

## openship access grants replace

Replace a user's complete resource grant set

```text
openship access grants replace [options] <file>
```

| Argument | Meaning |
| --- | --- |
| `file` | JSON object with userId and the complete grants array |

| Option | Meaning |
| --- | --- |
| `-y, --yes` | Skip confirmation |

## openship access grants set

Create or update one resource grant

```text
openship access grants set [options] <file>
```

| Argument | Meaning |
| --- | --- |
| `file` | JSON grant with userId, resourceType, resourceId and permissions |

## openship access members

Manage membership in the selected workspace

```text
openship access members [options] [command]
```

| Subcommand | Purpose |
| --- | --- |
| [`list`](/docs/cli/reference/access#openship-access-members-list) | List workspace members |
| [`role <id> <role>`](/docs/cli/reference/access#openship-access-members-role) | Change a member's role through the shared permission rules |
| [`remove [options] <id>`](/docs/cli/reference/access#openship-access-members-remove) | Remove a workspace member |

## openship access members list

List workspace members

```text
openship access members list [options]
```

## openship access members remove

Remove a workspace member

```text
openship access members remove [options] <id>
```

| Argument | Meaning |
| --- | --- |
| `id` | Member ID |

| Option | Meaning |
| --- | --- |
| `-y, --yes` | Skip confirmation |

## openship access members role

Change a member's role through the shared permission rules

```text
openship access members role [options] <id> <role>
```

| Argument | Meaning |
| --- | --- |
| `id` | Member ID |
| `role` | owner \| admin \| member \| restricted |

## openship access organization

Show the current organization and member count

```text
openship access organization [options]
```

## openship access resources

List resources available for permission grants

```text
openship access resources [options] <type>
```

| Argument | Meaning |
| --- | --- |
| `type` | Resource type |

| Option | Meaning |
| --- | --- |
| `--owner <id>` | Resource owner filter |

## openship access workspaces

List accessible workspaces and whether this credential can select an organization

```text
openship access workspaces [options]
```