Embedding an agent, authentication mechanism
{authToken}
. This process involves sending user identification details (such as externalId or email address) and your application credentials.
name
(optional, String): The friendly name to be set for the user in case of a new user creation.OR
externalId
(String): A unique identifier for the user to authenticate.
userEmail
(String): The email address of the user to authenticate.
accountUids
(optional, array of accountUid):
You can specify one or more Mindset App accounts to automatically add this user to. This allows embedded agent user sessions to be granted access to restricted agents.
https://MINDSET-LEGACYAPI-HOST/api-authenticate-embedded-user
endpoint from your back-end script. (MINDSET-LEGACYAPI-HOST
should be similar to europe-west2-mindset-prodX.cloudfunctions.net
)
To migrate, you will need to update your server-side code to use the new authentication endpoint and request body format as described below, and you will have to generate a new API KEY using the new API KEYS management system in your Mindset App admin area.
Generate a new API Key
x-api-key
headers param:
MINDSET-API-HOST
should be similar to x.api.mindset.ai
You can identify the user with either externalId
or userEmail
. You must provide one of these. Your request will be invalid if you provide neither of them, and also invalid if you provide values for both.
Please see the Back-end section for a full working example.
Please see the SDK Users API documentation for more details on the parameters options.
Please see the Agent access granted by Account membership for more details about the accountUids
parameter.