Self-hosted Flex: additional SSO configuration

If you're configuring SSO for a self-hosted Flex deployment, you need to update the appconfig.js configuration object to support authentication and single sign-on using a third-party identity provider (IdP).

For complete details about the configuration object and its properties, see the Flex UI API Reference.

The type of SSO you're using determines the changes you need to make:

• Legacy SSO configuration (2.6.x or earlier): Configure the sso object.
• Enhanced SSO configuration (2.7.x or later): Configure the sso object, and then add and configure the oauth object.

1. Set the sso object as follows:

1
appConfig.sso = {
2
    accountSid: string,
3
    loginPopup: boolean,
4
    loginPopupFeatures: string,
5
};

• accountSid is the Account SID of your Twilio project.
• loginPopup indicates whether to launch the IdP login in a new window. The default is false.
• loginPopupFeatures defines standard window.open() features to apply to the popup window.

1. Add the oauth object as follows:

1
appConfig.oauth = {
2
    connection: `${CONNECTION_NAME}`,
3
    clientId: `${CLIENT_ID}`,
4
    redirectUrl: `${DOMAIN_REDIRECT_URL}`,
5
};

2. Retrieve the connection and clientId values using this request, and then add them to the configuration. Make sure to add your Account SID before running the request:

curl --location 'https://services.twilio.com/v1/Flex/Authentication/Config?AccountSid={{YOUR_ACCOUNT_SID}}'

3. For the redirectUrl value, add any domains where Flex is hosted. You must register these domains in the Trusted Domains section of the Single sign-on setup page in Twilio Console.