> This page is for API Reference & Tools.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.moveworks.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.moveworks.com/_mcp/server.

# Assistant Access Rule

> Read and update Assistant Access Rule through the Moveworks Configuration API: endpoints, fields and examples.

`assistant.access-rule`

Who can use the assistant at all: a single MWDSL rule — `"TRUE"` enables the assistant for every user; an expression limits it to matching users. Empty = unset.

* **Endpoint:** `/assistant/access-rule`  |  **Methods:** GET, PATCH
* **Request shape:** one per organization, so there is no `id`. It already exists: read it with `GET`, then `PATCH` the fields you want to change. Fields go at the top level of the JSON body, with no `resource` wrapper.
* **Updates:** a JSON merge-patch. Send only the fields you change, plus `version: {num, change_description}` with the `num` from your last read. Lists and maps you send replace the stored ones whole.

### Endpoints

All paths are relative to `https://api.moveworks.ai/configurations/v1alpha1`. Each endpoint page lists the request and response schema, an example, and the errors it can return.

| Method  | Path                     | Endpoint reference                                                                                                               |
| ------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
| `GET`   | `/assistant/access-rule` | [Get assistant access rule](/api-reference/configuration-api/platform-org/assistant-access-rule/get-assistant-access-rule)       |
| `PATCH` | `/assistant/access-rule` | [Update assistant access rule](/api-reference/configuration-api/platform-org/assistant-access-rule/update-assistant-access-rule) |

### Fields

| Field          | Type    | Required  | Notes                                                                                                                                                           |
| -------------- | ------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `rule_dsl`     | string  |           | DSL rule controlling AI Assistant access. Set to TRUE to enable it for all users, or use a DSL expression to limit access to matching users. Empty means unset. |
| `updated_time` | string  | read-only | When the configuration was last updated.                                                                                                                        |
| `updated_by`   | string  | read-only | Who last updated the configuration.                                                                                                                             |
| `version`      | Version |           | Document version. On update, send back the num from your last read.                                                                                             |

### Document fields (example)

The document as `GET` returns it. To change any of these, send only the fields you want to change in the `PATCH` body.

```json
{
  "rule_dsl": "true"
}
```