---
title: "Users and Access"
description: "Generated TypeScript Management SDK methods for Users and Access."
---

> Documentation Index
> Fetch the complete documentation index at: https://nexus.microvoid.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Users and Access

These methods are generated from the Admin OpenAPI contract. They configure the control plane; they do not send model requests.

| Method                    | HTTP    | Path                                               | Reference                                                              |
| ------------------------- | ------- | -------------------------------------------------- | ---------------------------------------------------------------------- |
| `activateWorkspaceAccess` | `POST`  | `/admin/v1/workspace-accesses/{accessId}/activate` | [API](/api-reference/admin/users-and-access/activate-workspace-access) |
| `changeAccessPlan`        | `PATCH` | `/admin/v1/workspace-accesses/{accessId}/plan`     | [API](/api-reference/admin/users-and-access/change-access-plan)        |
| `getWorkspaceAccess`      | `GET`   | `/admin/v1/workspace-accesses/{accessId}`          | [API](/api-reference/admin/users-and-access/get-workspace-access)      |
| `listWorkspaceUsers`      | `GET`   | `/admin/v1/workspaces/{workspaceId}/users`         | [API](/api-reference/admin/users-and-access/list-workspace-users)      |
| `provisionWorkspaceUser`  | `POST`  | `/admin/v1/workspaces/{workspaceId}/users`         | [API](/api-reference/admin/users-and-access/provision-workspace-user)  |
| `renewWorkspaceAccess`    | `POST`  | `/admin/v1/workspace-accesses/{accessId}/renew`    | [API](/api-reference/admin/users-and-access/renew-workspace-access)    |
| `suspendWorkspaceAccess`  | `POST`  | `/admin/v1/workspace-accesses/{accessId}/suspend`  | [API](/api-reference/admin/users-and-access/suspend-workspace-access)  |

## Method signatures

### `activateWorkspaceAccess`

```ts
nexus.activateWorkspaceAccess(
  input: AdminOperationInput<"activateWorkspaceAccess">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"activateWorkspaceAccess">>
```

Activate a workspace access

### `changeAccessPlan`

```ts
nexus.changeAccessPlan(
  input: AdminOperationInput<"changeAccessPlan">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"changeAccessPlan">>
```

Change the plan bound to an access

### `getWorkspaceAccess`

```ts
nexus.getWorkspaceAccess(
  input: AdminOperationInput<"getWorkspaceAccess">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"getWorkspaceAccess">>
```

Get a workspace access

### `listWorkspaceUsers`

```ts
nexus.listWorkspaceUsers(
  input: AdminOperationInput<"listWorkspaceUsers">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"listWorkspaceUsers">>
```

List users with data-plane access to a workspace

### `provisionWorkspaceUser`

```ts
nexus.provisionWorkspaceUser(
  input: AdminOperationInput<"provisionWorkspaceUser">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"provisionWorkspaceUser">>
```

Idempotently provision a Better Auth user and workspace access

### `renewWorkspaceAccess`

```ts
nexus.renewWorkspaceAccess(
  input: AdminOperationInput<"renewWorkspaceAccess">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"renewWorkspaceAccess">>
```

Renew access and create the next quota period from active plan strategies

### `suspendWorkspaceAccess`

```ts
nexus.suspendWorkspaceAccess(
  input: AdminOperationInput<"suspendWorkspaceAccess">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"suspendWorkspaceAccess">>
```

Suspend new data-plane calls

Source: https://nexus.microvoid.io/management-sdk/reference/users-and-access/index.mdx