Skip to navigation

Get embedded assistant auth config

View as Markdown

Returns one embedded assistant auth config by its id.

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.

Response

The 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

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error