Accounts, Workspaces, and Permissions API¶

These routes establish caller identity and the workspace boundary used by the rest of the Product API. Workspace membership is not the same as MatrixOne database authorization: use database roles and grants for SQL objects.

Workspace bootstrap¶

Method and route	Purpose
`GET /newmoi/workspaces`	List workspaces visible to the caller; supported filters and pagination are deployment-defined
`POST /newmoi/workspaces`	Create a workspace
`POST /newmoi/workspaces/claim`	Claim or join a workspace through a deployment-supported claim flow
`GET /newmoi/workspaces/:id/users`	List users associated with a workspace
`PATCH /newmoi/workspaces/:id`	Update workspace metadata
`DELETE /newmoi/workspaces/:id`	Delete a workspace

List first and match a workspace by its returned ID. A name can be duplicated, and a create response that contains no resource data is not an ID source. Deletion affects every resource in the workspace; inventory dependencies and confirm ownership before calling it.

curl "$MOI_PRODUCT_ENDPOINT/newmoi/workspaces" \
  -H "X-API-Key: $MOI_PRODUCT_API_KEY"

Account and credentials¶

POST /newmoi/account/detail reads the current account detail. The /newmoi/user/me family covers self-service profile updates, Product API-key preview/reveal/refresh, and the workspace database connection information available to the caller. API-key reveal is sensitive: the full value must not be logged, placed in source code, or returned to an untrusted client.

These Product API credentials do not replace Genesis model API keys. They also must not be used as MatrixOne database passwords.

Members, roles, and permissions¶

Workspace member operations use the /newmoi/user family. The registered contract covers list, detail, create, profile updates, status changes, role-list updates, and deletion; /newmoi/log/user and /newmoi/log/role provide the corresponding operation-log reads. Send X-Workspace-ID on these calls and use only member and role identifiers returned in that workspace.

Role and resource-grant administration can depend on the deployment’s IAM configuration. Obtain its published contract before sending role, policy, grant, object-permission, or privilege-check payloads. Do not infer permission from menu visibility: validate both an allowed operation and a denied operation with a least-privilege test identity.

Audit logs¶

Method and route	Purpose
`GET /newmoi/audit/logs`	List workspace operation logs
`GET /newmoi/audit/logs/overview`	Read an aggregate audit overview

Filter by workspace, time, actor, method, status, or resource only when those filters are present in the deployed schema. Audit records help explain product writes; they do not contain MatrixOne SQL audit events unless the deployment explicitly integrates them.

Safe lifecycle¶

When removing or disabling a member, first transfer owned workflows, scheduled agent tasks, credentials, and operational responsibility. After a role or membership change, obtain fresh account/workspace state before testing access; an existing session can retain stale UI state even though the server decision has changed.

See Conventions for authentication and error behavior, and SQL for the separate database-permission boundary.