diff --git a/_documentation/en/index.md b/_documentation/en/index.md index 68939b0..27f4a38 100644 --- a/_documentation/en/index.md +++ b/_documentation/en/index.md @@ -24,4 +24,4 @@ The following Vonage Business Communications APIs are available: * [Provisioning API](/api/provisioning) - The Vonage Business Communications Provisioning API enables you to get details on Users, Accounts, and Extensions * [Telephony API](/api/telephony) - The Vonage Business Communications Telephony API enables you to manage calls and retrieve device registration information * [Reports API](/api/reports) - The Vonage Business Communications Reports API enables you to retrieve call logs for your account -* [Vonage Integration Platform API](/api/vonage-integration-platform) - The Vonage Business Communications Reports API enables you to manage calls and receive real-time call events via HTTP webhooks \ No newline at end of file +* [Vonage Integration Platform API](/api/vonage-integration-platform) - The Vonage Business Communications Reports API enables you to manage calls and receive real-time call events via HTTP webhooks diff --git a/_tutorials/en/call-recording/config-saml.md b/_tutorials/en/call-recording/config-saml.md new file mode 100644 index 0000000..5ac8245 --- /dev/null +++ b/_tutorials/en/call-recording/config-saml.md @@ -0,0 +1,39 @@ +--- +title: Configure a SAML integration +description: In this step you learn how to configure a SAML integration in your Okta developer account. +--- + +## Configure a SAML integration + +When configuring a SAML integration, you will need to enter the URLs and SP issuer values provided by Vonage Business Communications. + +1. Click **Show Advanced Settings** on the **Configure SAML** tab. +2. Enter the following in the specified fields: + a. **SP (Entity ID)**: vonage-vbc + b. **Single Sign-On URL**: https://login.auth.vonage.com/accountrecoveryendpoint/saml-translator.jsp?id={customer_account_number}&env=prod&client=Web + c. **Requestable SSO URL**: https://login.auth.vonage.com/commonauth + d. **Relay State**: 0 + e. **Logout URL**: https://login.auth.vonage.com/commonauth + ![Screenshot showing Okta SAML configuration settings on Advanced Settings dialog box](/images/tutorials/okta-config/Okta_5.png) + ![Screenshot showing Okta SAML configuration settings on Advanced Settings dialog box](/images/tutorials/okta-config/Okta_6.png) +3. On the **Feedback** tab, select the **I'm an Okta customer adding an internal app** radio button. + ![Screenshot showing Feedback tab in Okta SAML configuration settings](/images/tutorials/okta-config/Okta_7.png) +4. Click **Finish**. + You will see the following propmt once you are finished creating an application. The message states **SAML 2.0 is not configured until you complete the setup instructions.** + ![Screenshot showing Feedback tab in Okta SAML configuration settings](/images/tutorials/okta-config/Okta_8.png) +5. Click **View Setup Instructions**. + The setup instructions window opens. + ![Screenshot showing Feedback tab in Okta SAML configuration settings](/images/tutorials/okta-config/Okta_9.png) +6. In a separate browser window, open the Vonage Business Communications [Single Sign-on Settings](https://admin.vonage.com/management/m/ssoSettings) page. +7. Enter the values from Okta into the appropriate fields on the Vonage Business Communications Single Sign-on Settings page: + | Okta Setting | VBC Setting | + |------------------------------------------|---------------------------------------------------------------| + | Identity Provider Sign-on URL | Sign-in page URL | + | Identity Provider Issuer | Entity ID | + | Identity Provider Single Logout URL | Sign-out page URL | +8. Upload your X509 certificate from the previous section via **Upload Certificate**. +9. Once you have entered all the necessary values in the appropriate fields, click **Save**. + +> Note: To assign users to your application, follow [these instructions](https://developer.okta.com/docs/guides/saml-application-setup/assign-users-to-the-app/) + +> Note: To enable a flexible username format (other than email addresses), refer to [these instructions](https://help.okta.com/en/prod/Content/Topics/Directory/eu-profile_editor_tasks.htm) diff --git a/_tutorials/en/call-recording/create-app.md b/_tutorials/en/call-recording/create-app.md new file mode 100644 index 0000000..8d6a642 --- /dev/null +++ b/_tutorials/en/call-recording/create-app.md @@ -0,0 +1,22 @@ +--- +title: Create an application in Okta +description: In this step you learn how to create an application in your Okta developer account. +--- + +# Create an application in Okta + +When you add an app to your Okta applications, one of the single sign-on options available to you is SAML-based single sign-on. To configure Okta for Vonage Business Communications choose SAML. + +1. Sign in to the [Okta Developer Portal](https://developer.okta.com) using your Okta developer account. +2. Click the **Applications** option on the top navigation menu. +3. Select the **Classic UI** option from the drop-down menu above the top navigation menu. +4. Select **Add Application**. + A **Search** interface opens. + ![Screenshot showing Okta Search Applications interface](/images/tutorials/okta-config/Okta_1.png) +5. Click **Create New App** on the **Add Application** page. + ![Screenshot showing Okta Add Application page](/images/tutorials/okta-config/Okta_2.png) +6. Select **Web** in the **Platform** drop-down menu on the **Create a new Application Integration** dialog box. +7. Select the **SAML 2.0** radio button on the **Create a new Application Integration** dialog box. + ![Screenshot showing Okta Create a new Application Integration dialog box](/images/tutorials/okta-config/Okta_3.png) +8. Click the **Create** button. + Now you are ready to create a SAML integration. diff --git a/_tutorials/en/call-recording/create-saml-integration.md b/_tutorials/en/call-recording/create-saml-integration.md new file mode 100644 index 0000000..70f2d2a --- /dev/null +++ b/_tutorials/en/call-recording/create-saml-integration.md @@ -0,0 +1,11 @@ +--- +title: Create a SAML integration +description: In this step you learn how to create a SAML integration in your Okta developer account. +--- + +## Create a SAML Integration + +1. In the **App Name** text box, type the display name for your new integration. + ![Screenshot showing Okta Create SAML Integration page](/images/tutorials/okta-config/Okta_4.png) +2. Click **Next**. + You are now ready to configure your SAML integration. diff --git a/_tutorials/en/call-recording/okta-dev-acct.md b/_tutorials/en/call-recording/okta-dev-acct.md new file mode 100644 index 0000000..32aa2a9 --- /dev/null +++ b/_tutorials/en/call-recording/okta-dev-acct.md @@ -0,0 +1,6 @@ +--- +title: Create an Okta developer account +description: In this step you learn how to create an application in your Okta developer account. +--- + +An Okta account is required to configure single sign-on using Okta. If you do not have an Okta account, [sign up](https://developer.okta.com/signup/) for a developer account. diff --git a/config/tutorials/en/okta-config.yml b/config/tutorials/en/okta-config.yml new file mode 100644 index 0000000..c595045 --- /dev/null +++ b/config/tutorials/en/okta-config.yml @@ -0,0 +1,31 @@ +title: Enabling OKTA SSO configurations for your VBC users +description: Okta enables single sign-on access to cloud applications such as Vonage Business Communications. This tutorial demonstrates how to enable Okta SSO configurations for your Vonage Business Communications users. +products: + - call-recording + +introduction: + title: Introduction to this tutorial + description: This tutorial demonstrates how to enable Okta SSO configurations for your Vonage Business Communications users. + content: | + # Introduction + Okta is a cloud-based identity and access management service, which helps your employees sign in and access resources. Okta enables single sign-on access to cloud applications such as Vonage Business Communications. Once a user signs into Okta, they can then launch any of their enabled web apps without having to re-enter their login credentials for each app. Okta establishes a secure connection with the user’s browser and then authenticates the user to log in to Okta managed apps via SAML, a pre-integrated, federated authentication protocol. + + This tutorial provides a step-by-step guide on configuring single sign-on for Vonage Business Communications using Okta as your identity provider (IDP). + +prerequisites: +- call-recording/okta-dev-acct + +tasks: +- call-recording/create-app +- call-recording/create-saml-integration +- call-recording/config-saml + +conclusion: + title: What's next? + description: What else can you do to configure Okta single sign-on for your Vonage Business Communication users? + content: | + + # What's next? + If usernames in Vonage Business Communications (VBC) and Okta don’t quite line-up, you can modify Okta usernames with profile mappings. + + See [Modify Okta usernames with profile mappings](/messages/overview). diff --git a/public/images/tutorials/okta-config/Okta_1.png b/public/images/tutorials/okta-config/Okta_1.png new file mode 100644 index 0000000..7d1191b Binary files /dev/null and b/public/images/tutorials/okta-config/Okta_1.png differ diff --git a/public/images/tutorials/okta-config/Okta_2.png b/public/images/tutorials/okta-config/Okta_2.png new file mode 100644 index 0000000..bd82152 Binary files /dev/null and b/public/images/tutorials/okta-config/Okta_2.png differ diff --git a/public/images/tutorials/okta-config/Okta_3.png b/public/images/tutorials/okta-config/Okta_3.png new file mode 100644 index 0000000..a26634d Binary files /dev/null and b/public/images/tutorials/okta-config/Okta_3.png differ diff --git a/public/images/tutorials/okta-config/Okta_4.png b/public/images/tutorials/okta-config/Okta_4.png new file mode 100644 index 0000000..21c657c Binary files /dev/null and b/public/images/tutorials/okta-config/Okta_4.png differ diff --git a/public/images/tutorials/okta-config/Okta_5.png b/public/images/tutorials/okta-config/Okta_5.png new file mode 100644 index 0000000..a364b5b Binary files /dev/null and b/public/images/tutorials/okta-config/Okta_5.png differ diff --git a/public/images/tutorials/okta-config/Okta_6.png b/public/images/tutorials/okta-config/Okta_6.png new file mode 100644 index 0000000..23823b3 Binary files /dev/null and b/public/images/tutorials/okta-config/Okta_6.png differ diff --git a/public/images/tutorials/okta-config/Okta_7.png b/public/images/tutorials/okta-config/Okta_7.png new file mode 100644 index 0000000..a911dae Binary files /dev/null and b/public/images/tutorials/okta-config/Okta_7.png differ diff --git a/public/images/tutorials/okta-config/Okta_8.png b/public/images/tutorials/okta-config/Okta_8.png new file mode 100644 index 0000000..be6d9c1 Binary files /dev/null and b/public/images/tutorials/okta-config/Okta_8.png differ diff --git a/public/images/tutorials/okta-config/Okta_9.png b/public/images/tutorials/okta-config/Okta_9.png new file mode 100644 index 0000000..0fcaa89 Binary files /dev/null and b/public/images/tutorials/okta-config/Okta_9.png differ