> ## Documentation Index
> Fetch the complete documentation index at: https://docs.honeyhive.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Workspace Members

> List a workspace's members, invite people to it, set a member's roles, and remove people from it and from every project in it. Available on self-hosted deployments that do not enable an SSO group scheme.

## Schema introspection

Every command below with arguments supports two read-only flags for tooling and AI agents:

* `--show-file-schema`: print the JSON Schema for the full request object (the format `--filename` accepts).
* `--show-argument-schema <flag-name>`: print the JSON Schema for one argument's value. Pass the kebab flag name **without** the leading `--` (e.g. `workspace-id`, not `--workspace-id`).

Both write pure JSON to stdout and never call the API. They cannot be combined with any other command-specific flag.

## `list`

List a workspace's members

Return one page of a workspace's members, oldest membership first. Each member carries their
roles in the workspace and whether they have signed in yet. The workspace is identified by
the `workspace_id` path parameter alone. The `x-hh-workspace-id` header does not
participate.

Available on self-hosted deployments that do not enable an SSO group scheme. Elsewhere this
operation returns 404. An API key that carries a membership permission can carry no
permission other than the roles and membership permissions, and is created on an
organization.

### Usage

```sh theme={null}
honeyhive workspace-members list [options]
```

**Accepted keys:** [Control plane fine-grained API key](https://docs.honeyhive.ai/v2/workspace/api-keys.md#key-types)

### Options

| Flag | Type | Required | Description |
| - | - | - | - |
| `--workspace-id` | string | yes | The unique identifier of the workspace |
| `--limit` | number | no | Number of members to return per page |
| `--page` | number | no | 1-indexed page number |

Also supports `--show-file-schema`, `--show-argument-schema <flag-name>`, and `--filename`. See [Schema introspection](#schema-introspection) for details.

## `create`

Invite someone to a workspace

Invite one email address to a workspace, and return the member. The address is stored
lowercased. An address with no HoneyHive user yet gets one, and the invitee receives an
email. An email sent for a request made with an API key names the inviter as a HoneyHive
teammate.

The invitee also becomes a member, with no roles, of the workspace's virtual data plane and
organization, wherever they are not one already.

The new member has no roles, and is `INVITED` until they first sign in. Sign-in keeps any
roles set before then and adds the roles the organization's roles manifest gives invited
members. To give them roles now, set their roles with the `user_id` this returns.

Inviting an address that is already a member returns that member unchanged, and sends no
email, so sending the same invite again is safe. The workspace is identified by the
`workspace_id` path parameter alone. The `x-hh-workspace-id` header does not participate.

Available on self-hosted deployments that do not enable an SSO group scheme. Elsewhere this
operation returns 404. An API key that carries a membership permission can carry no
permission other than the roles and membership permissions, and is created on an
organization.

### Usage

```sh theme={null}
honeyhive workspace-members create [options]
```

**Accepted keys:** [Control plane fine-grained API key](https://docs.honeyhive.ai/v2/workspace/api-keys.md#key-types)

### Options

| Flag | Type | Required | Description |
| - | - | - | - |
| `--email` | string | yes | The address to invite. It is stored lowercased, because sign-in matches addresses that way |
| `--workspace-id` | string | yes | The unique identifier of the workspace |

Also supports `--show-file-schema`, `--show-argument-schema <flag-name>`, and `--filename`. See [Schema introspection](#schema-introspection) for details.

## `update`

Set a member's roles in a workspace

Replace a member's roles in a workspace with the roles given, and return the member. The
member's current sessions must reauthorize, so the new roles apply immediately. The member
may still be `INVITED`. The workspace and the member are identified by the path parameters
alone. The `x-hh-workspace-id` header does not participate.

Each role must be one the organization's roles manifest defines for workspaces, which are
the roles the HoneyHive app offers there. Any other role is refused with 400, including one
a manifest change removed, so writing back roles read before such a change can fail. When
the organization has no valid roles manifest in force, the roles cannot be checked and the
request is refused with 409.

Available on self-hosted deployments that do not enable an SSO group scheme. Elsewhere this
operation returns 404. An API key that carries a membership permission can carry no
permission other than the roles and membership permissions, and is created on an
organization.

### Usage

```sh theme={null}
honeyhive workspace-members update [options]
```

**Accepted keys:** [Control plane fine-grained API key](https://docs.honeyhive.ai/v2/workspace/api-keys.md#key-types)

### Options

| Flag | Type | Required | Description |
| - | - | - | - |
| `--role-names` | json | yes | The member's new roles at this scope, replacing the old ones. Each must be a role the organization's roles manifest defines for this scope's type, which are the roles the HoneyHive app offers for a member here. Any other role is refused with 400, including one a manifest change removed, so writing back roles read before a manifest change can fail |
| `--user-id` | string | yes | The member's user id, as the member list returns it. One person has the same user id in every organization, workspace and project |
| `--workspace-id` | string | yes | The unique identifier of the workspace |

Also supports `--show-file-schema`, `--show-argument-schema <flag-name>`, and `--filename`. See [Schema introspection](#schema-introspection) for details.

## `delete`

Remove someone from a workspace

Remove a user from a workspace and from every project in it, which also withdraws a pending
invite. The user's current sessions must reauthorize. Their HoneyHive user stays, along with
their memberships of the workspace's virtual data plane and organization. The workspace and
the user are identified by the path parameters alone. The `x-hh-workspace-id` header does
not participate.

Available on self-hosted deployments that do not enable an SSO group scheme. Elsewhere this
operation returns 404. An API key that carries a membership permission can carry no
permission other than the roles and membership permissions, and is created on an
organization.

### Usage

```sh theme={null}
honeyhive workspace-members delete [options]
```

**Accepted keys:** [Control plane fine-grained API key](https://docs.honeyhive.ai/v2/workspace/api-keys.md#key-types)

### Options

| Flag | Type | Required | Description |
| - | - | - | - |
| `--user-id` | string | yes | The member's user id, as the member list returns it. One person has the same user id in every organization, workspace and project |
| `--workspace-id` | string | yes | The unique identifier of the workspace |

Also supports `--show-file-schema`, `--show-argument-schema <flag-name>`, and `--filename`. See [Schema introspection](#schema-introspection) for details.


## Related topics

- [Workspace Members Methods](https://docs.honeyhive.ai/v2/control-plane-sdk-reference/typescript/ref/workspace-members/index.md)
- [DeleteWorkspaceMemberRequest](https://docs.honeyhive.ai/v2/control-plane-sdk-reference/typescript/ref/workspace-members/DeleteWorkspaceMemberRequest.md)
- [UpdateWorkspaceMemberRequest](https://docs.honeyhive.ai/v2/control-plane-sdk-reference/typescript/ref/workspace-members/UpdateWorkspaceMemberRequest.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.