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 |
changeAccessPlan |
PATCH |
/admin/v1/workspace-accesses/{accessId}/plan |
API |
getWorkspaceAccess |
GET |
/admin/v1/workspace-accesses/{accessId} |
API |
listWorkspaceUsers |
GET |
/admin/v1/workspaces/{workspaceId}/users |
API |
provisionWorkspaceUser |
POST |
/admin/v1/workspaces/{workspaceId}/users |
API |
renewWorkspaceAccess |
POST |
/admin/v1/workspace-accesses/{accessId}/renew |
API |
suspendWorkspaceAccess |
POST |
/admin/v1/workspace-accesses/{accessId}/suspend |
API |
Method signatures
activateWorkspaceAccess
nexus.activateWorkspaceAccess(
input: AdminOperationInput<"activateWorkspaceAccess">,
options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"activateWorkspaceAccess">>Activate a workspace access
changeAccessPlan
nexus.changeAccessPlan(
input: AdminOperationInput<"changeAccessPlan">,
options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"changeAccessPlan">>Change the plan bound to an access
getWorkspaceAccess
nexus.getWorkspaceAccess(
input: AdminOperationInput<"getWorkspaceAccess">,
options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"getWorkspaceAccess">>Get a workspace access
listWorkspaceUsers
nexus.listWorkspaceUsers(
input: AdminOperationInput<"listWorkspaceUsers">,
options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"listWorkspaceUsers">>List users with data-plane access to a workspace
provisionWorkspaceUser
nexus.provisionWorkspaceUser(
input: AdminOperationInput<"provisionWorkspaceUser">,
options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"provisionWorkspaceUser">>Idempotently provision a Better Auth user and workspace access
renewWorkspaceAccess
nexus.renewWorkspaceAccess(
input: AdminOperationInput<"renewWorkspaceAccess">,
options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"renewWorkspaceAccess">>Renew access and create the next quota period from active plan strategies
suspendWorkspaceAccess
nexus.suspendWorkspaceAccess(
input: AdminOperationInput<"suspendWorkspaceAccess">,
options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"suspendWorkspaceAccess">>Suspend new data-plane calls