Skip to navigation

Create embedded assistant auth config

View as Markdown

Creates a embedded assistant auth config and returns it with its server-assigned id and version.

Send the fields at the top level of the body. Don’t send id or version.num; version.change_description is required.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
keystringRequiredformat: "^[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.

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 created embedded assistant auth config
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
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error