Skip to navigation

Assistant Access Rule

View as Markdown

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.

MethodPathEndpoint reference
GET/assistant/access-ruleGet assistant access rule
PATCH/assistant/access-ruleUpdate assistant access rule

Fields

FieldTypeRequiredNotes
rule_dslstringDSL 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_timestringread-onlyWhen the configuration was last updated.
updated_bystringread-onlyWho last updated the configuration.
versionVersionDocument 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.

{
"rule_dsl": "true"
}