Skip to navigation

Embedded Assistant Auth

View as Markdown

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.

MethodPathEndpoint reference
GET/assistant/embedded-assistant-authList embedded assistant auth configs
POST/assistant/embedded-assistant-authCreate embedded assistant auth config
GET/assistant/embedded-assistant-auth/{id}Get embedded assistant auth config
PATCH/assistant/embedded-assistant-auth/{id}Update embedded assistant auth config

Fields

FieldTypeRequiredNotes
idstringread-onlyUnique identifier of the authentication configuration, assigned by the server. Cannot be changed.
keystring✅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_ssoGenericSSOSettingsAuthenticate users through an SSO configuration.
service_nowServiceNowSettingsAuthenticate users natively through your ServiceNow portal.
sharepointSharepointSettingsAuthenticate users natively through your SharePoint portal.
updated_timestringread-onlyWhen the configuration was last updated.
updated_bystringread-onlyWho last updated the configuration.
versionVersion✅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.

FieldTypeRequiredNotes
sso_idstring✅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.

FieldTypeRequiredNotes
identity_configIdentitySettingsHow the authenticated user identity is matched to a Moveworks user.
jwt_public_keystring✅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.

FieldTypeRequiredNotes
identity_configIdentitySettingsHow the authenticated user identity is matched to a Moveworks user.
tenant_idstringAzure tenant ID that hosts your SharePoint.

Example create body

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