Skip to navigation

Update embedded assistant auth config

View as Markdown

Changes the fields you send and returns the full updated document.

Send only the fields you want to change, plus version with the num from your last read and a change_description. This is a JSON merge-patch: a field you leave out keeps its stored value, and every list or map you send replaces the stored one whole. The id goes in the URL; if you also send id in the body it must match.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Path parameters

idstringRequired

The id of the embedded assistant auth config, as returned when it was created or listed.

Request

This endpoint expects an object.
versionobjectRequired
Document version. On update, send back the num from your last read.
generic_ssoobjectOptional
Authenticate users through an SSO configuration.
service_nowobjectOptional
Authenticate users natively through your ServiceNow portal.
sharepointobjectOptional
Authenticate users natively through your SharePoint portal.

Response

The updated embedded assistant auth config, at its new version
idstringOptionalRead-only
Unique identifier of the authentication configuration, assigned by the server. Cannot be changed.
keystringOptionalformat: "^[a-z0-9]+$">=1 character

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_ssoobjectOptional
Authenticate users through an SSO configuration.
service_nowobjectOptional
Authenticate users natively through your ServiceNow portal.
sharepointobjectOptional
Authenticate users natively through your SharePoint portal.
updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error