Connect Okta as an identity provider

Citrix Cloud Japan supports using Okta as an identity provider to authenticate subscribers signing in to their workspaces. By connecting your Okta organization to Citrix Cloud Japan, you can provide a common sign-in experience for your subscribers to access resources in Citrix Workspace.

After enabling Okta authentication in Workspace Configuration, subscribers have a different sign-in experience. Selecting Okta authentication provides federated sign-in, not single sign-on. Subscribers sign in to workspaces from an Okta sign-in page, but they may have to authenticate a second time when opening an app or desktop from the Citrix Virtual Apps and Desktops service. To enable single sign-on and prevent a second logon prompt, you need to use the Citrix Federated Authentication Service with Citrix Cloud Japan. For more information, see Connect Citrix Federated Authentication Service to Citrix Cloud.

Tip:

Learn more about supported identity providers with the Introduction to Citrix Identity and Authentication education course. The “Planning Citrix Identity and Access Management” module includes short videos that walk you through connecting this identity provider to Citrix Cloud Japan and enabling authentication for Citrix Workspace.

Prerequisites

Cloud Connectors

You need at least two (2) servers in your Active Directory domain on which to install the Citrix Cloud Connector software. Cloud Connectors are required for enabling communication between Citrix Cloud Japan and your resource location. Citrix recommends two servers for Cloud Connector high availability. These servers must meet the following requirements:

  • Meets the requirements described in Cloud Connector requirements.
  • Does not have any other Citrix components installed, is not an Active Directory domain controller, and is not a machine critical to your resource location infrastructure.
  • Joined to your Active Directory (AD) domain. If your workspace resources and users reside in multiple domains, you must install at least two Cloud Connectors in each domain. For more information, see Deployment scenarios for Cloud Connectors in Active Directory.
  • Connected to a network that can contact the resources that users access through Citrix Workspace.
  • Connected to the Internet. For more information, see Service connectivity requirements.

For more information about installing the Cloud Connector, refer to the following articles:

Okta domain

When connecting Okta to Citrix Cloud Japan, you must supply the Okta domain for your organization. Citrix supports the following Okta domains:

  • okta.com
  • okta-eu.com
  • oktapreview.com

You can also use Okta custom domains with Citrix Cloud Japan. Review the important considerations for using custom domains in Customize the Okta URL domain on the Okta web site.

For more information about locating the custom domain for your organization, see Finding Your Okta Domain on the Okta web site.

Okta OIDC web application

To use Okta as an identity provider, you must first create an Okta OIDC web application with client credentials you can use with Citrix Cloud Japan. After you create and configure the application, note the Client ID and Client Secret. You supply these values to Citrix Cloud Japan when you connect your Okta organization.

To create and configure this application, see the following sections in this article:

Workspace URL

When creating the Okta application, you must supply your Workspace URL from Citrix Cloud Japan. To locate the Workspace URL, select Workspace Configuration from the Citrix CloudJapan menu. The Workspace URL is shown on the Access tab.

Important:

If you modify the workspace URL later on, you must update the Okta application configuration with the new URL. Otherwise, your subscribers might experience issues with signing out of their workspace.

Okta API token

Using Okta as an identity provider with Citrix Cloud Japan requires an API token for your Okta organization. Create this token using a Read-Only Administrator account in your Okta organization. This token must be able to read the users and groups in your Okta organization.

To create the API token, see Create an Okta API token in this article. For more information about API tokens, see Create an API Token on the Okta website.

Important:

When you create the API token, make a note of the token value (for example, copy the value temporarily to a plain text document). Okta displays this value only once, so you might create the token just before you perform the steps in Connect Citrix Cloud Japan to your Okta organization.

Sync accounts with the Okta AD agent

To use Okta as an identity provider, you must first integrate your on-premises AD with Okta. To do this, you install the Okta AD agent in your domain and add your AD to your Okta organization. For guidance for deploying the Okta AD agent, see Get started with Active Directory integration on the Okta web site. Afterward, you import your AD users and groups to Okta. When importing, include the SID, UPN, and OID values associated with your AD accounts.

Note:

If you are using Citrix Gateway service with Workspace, you don’t need to synchronize your AD accounts with your Okta organization.

To synchronize your AD users and groups with your Okta organization:

  1. Install and configure the Okta AD agent. For complete instructions, refer to the following articles on the Okta website:
  2. Add your AD users and groups to Okta by performing a manual import or an automated import. For more information about Okta import methods and instructions, refer to Manage Active Directory users and groups on the Okta website.

Create an Okta OIDC web app integration

  1. From the Okta management console, under Applications, select Applications.
  2. Select Create App Integration.
  3. In Sign in method, select OIDC - OpenID Connect and then select Web Application. Select Next.
  4. Enter an app integration name.
  5. In Grant type, select the following options:
    • Authorization Code
    • Implicit (Hybrid)
  6. In Sign-in redirect URIs, enter https://accounts.citrixcloud.jp/core/login-okta.
  7. In Sign-out redirect URIs, enter your Workspace URL from Citrix Cloud Japan.
  8. In Assignments, select whether to assign the app integration to everyone in your organization, only groups that you specify, or to assign access later.
  9. Select Save.

After you save the app integration, the console displays Client ID and Client Secret values in the Client Credentials sections. You use these values When you connect Citrix Cloud Japan to your Okta organization.

Configure the Okta OIDC web application

In this step, you configure your Okta OIDC web application with the settings required for Citrix Cloud Japan. Citrix Cloud Japan requires these settings to authenticate your subscribers through Okta when they sign in to their workspaces.

  1. (Optional) Update client permissions for the implicit grant type. You might choose to perform this step if you prefer to allow the least amount of privilege for this grant type.
    1. From the Okta application configuration page, under General Settings, select Edit.
    2. In the Application section, under Client acting on behalf of itself, clear the Allow Access Token with implicit grant type.
    3. Select Save.
  2. Add application attributes. These attributes are case-sensitive.
    1. From the Okta console menu, select Directory > Profile Editor.
    2. Locate the Okta user profile and select Profile. Under Attributes, select Add attribute.
    3. Enter the following information:
      • Display Name: cip_sid
      • Variable Name: cip_sid
      • Description: AD User Security Identifier
      • Attribute Length: Greater than 1
      • Attribute Required: Yes
    4. Select Save and Add Another.
    5. Enter the following information:
      • Display Name: cip_upn
      • Variable Name: cip_upn
      • Description: AD User Principal Name
      • Attribute Length: Greater than 1
      • Attribute Required: Yes
    6. Select Save and Add Another.
    7. Enter the following information:
      • Display Name: cip_oid
      • Variable Name: cip_oid
      • Description: AD User GUID
      • Attribute Length: Greater than 1
      • Attribute Required: Yes
    8. Select Save.
  3. Edit attribute mappings for the application:
    1. From the Okta console, select Directory > Directory Integrations.
    2. Select the AD you previously integrated. For more information, see Sync accounts with the Okta AD agent
    3. Select the Provisioning tab and then select Settings > To Okta.
    4. Under Okta Attribute Mappings, map the following attributes. Select Save after modifying each attribute.
      • Select appuser.objectSid and map to the cip_sid attribute.
      • Select appuser.userName and map to the cip_upn attribute.
      • Select appuser.externalId and map to the cip_oid attribute.
    5. Select Force Sync.

Create an Okta API token

  1. Sign in to the Okta console using a Read-Only Administrator account.
  2. From the Okta console menu, select Security > API.
  3. Select the Tokens tab and then select Create Token.
  4. Enter a name for the token.
  5. Select Create Token.
  6. Copy the token value. You supply this value when you connect your Okta organization to Citrix Cloud Japan.

Connect Citrix Cloud Japan to your Okta organization

  1. Sign in to Citrix Cloud Japan at https://citrix.citrixcloud.jp.
  2. From the Citrix Cloud Japan menu in the upper-left corner of the management console, select Identity and Access Management.
  3. Locate Okta and select Connect from the ellipsis menu.
  4. In Okta URL, enter your Okta domain.
  5. In Okta API Token, enter the API token for your Okta organization.
  6. In Client ID and Client Secret, enter the client ID and secret from the OIDC web app integration you created earlier. To copy these values from the Okta console, select Applications and locate your Okta application. Under Client Credentials, use the Copy to Clipboard button for each value.
  7. Click Test and Finish. Citrix Cloud Japan verifies your Okta details and tests the connection.

Enable Okta authentication for workspaces

  1. From the Citrix Cloud Japan menu, select Workspace Configuration > Authentication.
  2. Select Okta. If prompted, select I understand the impact on the subscriber experience.
  3. Click Accept to accept the permissions request.
Connect Okta as an identity provider