> 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.

# Embedded Assistant Auth

> Create, read and update Embedded Assistant Auth through the Moveworks Configuration API: endpoints, fields and examples.

`assistant.embedded-assistant-auth`

SSO/auth settings for the embedded (web) assistant.

* **Endpoint:** `/assistant/embedded-assistant-auth`  |  **Methods:** GET, PATCH, POST
* **Request shape:** fields go at the top level of the JSON body, with no `resource` wrapper. The item's `id` goes in the URL for reads and updates, not in the body.
* **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/embedded-assistant-auth`      | [List embedded assistant auth configs](/api-reference/configuration-api/platform-org/embedded-assistant-auth/list-embedded-assistant-auth-configs)   |
| `POST`  | `/assistant/embedded-assistant-auth`      | [Create embedded assistant auth config](/api-reference/configuration-api/platform-org/embedded-assistant-auth/create-embedded-assistant-auth-config) |
| `GET`   | `/assistant/embedded-assistant-auth/{id}` | [Get embedded assistant auth config](/api-reference/configuration-api/platform-org/embedded-assistant-auth/get-embedded-assistant-auth-config)       |
| `PATCH` | `/assistant/embedded-assistant-auth/{id}` | [Update embedded assistant auth config](/api-reference/configuration-api/platform-org/embedded-assistant-auth/update-embedded-assistant-auth-config) |

### Fields

| Field          | Type               | Required  | Notes                                                                                                                                                                          |
| -------------- | ------------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `id`           | string             | read-only | Unique identifier of the authentication configuration, assigned by the server. Cannot be changed.                                                                              |
| `key`          | string             | ✅         | Key that embed clients use to select this configuration. Lowercase letters and digits only; the first key for each method should be default. Cannot be changed after creation. |
| `generic_sso`  | GenericSSOSettings |           | Authenticate users through an SSO configuration.                                                                                                                               |
| `service_now`  | ServiceNowSettings |           | Authenticate users natively through your ServiceNow portal.                                                                                                                    |
| `sharepoint`   | SharepointSettings |           | Authenticate users natively through your SharePoint portal.                                                                                                                    |
| `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.                                                                                                            |

Set at most one of `generic_sso`, `service_now`, `sharepoint`.

### Variants (3, pick one)

**`generic_sso`**

Authenticate users through an SSO configuration.

| Field    | Type   | Required | Notes                                                                                                                            |
| -------- | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `sso_id` | string | ✅        | The SSO configuration used to authenticate users. ID of an existing sso (GET /configurations/v1alpha1/platform/sso-connections). |

**`service_now`**

Authenticate users natively through your ServiceNow portal.

| Field             | Type             | Required | Notes                                                                                                                                                                   |
| ----------------- | ---------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `identity_config` | IdentitySettings |          | How the authenticated user identity is matched to a Moveworks user.                                                                                                     |
| `jwt_public_key`  | string           | ✅        | Contents of the .crt certificate (JWT public key) issued by Moveworks, used to verify tokens from your ServiceNow portal. Secret: always returned masked as \*\*\*\*\*. |

**`sharepoint`**

Authenticate users natively through your SharePoint portal.

| Field             | Type             | Required | Notes                                                               |
| ----------------- | ---------------- | -------- | ------------------------------------------------------------------- |
| `identity_config` | IdentitySettings |          | How the authenticated user identity is matched to a Moveworks user. |
| `tenant_id`       | string           |          | Azure tenant ID that hosts your SharePoint.                         |

### Example create body

```json
{
  "key": "example",
  "generic_sso": {
    "sso_id": "<id>"
  },
  "version": {
    "change_description": "Create embedded assistant auth config"
  }
}
```