---
title: Integrate with VMware Cloud Director
sidebar_label: VMware Cloud Director
support_level: community
---

## What is VMware Cloud Director

> VMware Cloud Director is a platform that enables service providers and enterprises to create multi-tenant virtual data centers (VDCs) from underlying VMware vSphere infrastructure. It supports self-service resource provisioning, secure tenant isolation, and management of compute, storage, and networking via web portals and APIs.
>
> -- https://www.vmware.com/products/cloud-infrastructure/cloud-director

The following placeholders will be used in the examples below:

- `authentik.company` is the FQDN of the authentik installation.
- `clouddirector.company` is the FQDN of the VMware Cloud Director instance.

:::info
This documentation lists only the settings that you need to change from their default values. Be aware that any changes other than those explicitly mentioned in this guide could cause issues accessing your application.
:::

## authentik configuration

To support the integration of VMware Cloud Director with authentik, you need to create an application/provider pair in authentik.

### Create an application and provider in authentik

1. Log in to authentik as an administrator and open the authentik Admin interface.
2. Navigate to **Applications** > **Applications** and click **New Application** to open the application wizard.
    - **Application**: provide a descriptive name, an optional group for the type of application, the policy engine mode, and optional UI settings.
    - **Choose a Provider type**: select **OAuth2/OpenID Connect** as the provider type.
    - **Configure the Provider**: provide a name (or accept the auto-provided name), the authorization flow to use for this provider, and the following required configurations.
        - Note the **Client ID**, **Client Secret**, and **slug** values because they will be required later.
        - Set a `Strict` redirect URI to `https://clouddirector.company/login/oauth?service=provider`.
        - Select any available signing key.
    - **Configure Bindings** _(optional)_: you can create a [binding](/docs/add-secure-apps/flows-stages/bindings/) (policy, group, or user) to manage the listing and access to applications on a user's **My applications** page.

:::info Tenant configuration
The redirect URI is for provider level configuration. If you're configuring a tenant-level integration in VMware Cloud Director, use the URI displayed in [step 2 of the VMware Cloud Director configuration](#vmware-cloud-director-configuration).
:::

3. Click **Submit** to save the new application and provider.

## VMware Cloud Director configuration

1. Log in to VMware Cloud Director with your local administrator account. Using the menu in the left navigation bar, navigate to **Administration** > **Identity Providers** > **OIDC**.
2. Click the blue **Configure** button in the middle of the screen.
3. In the wizard, set the following values:
    - Set **Client ID** to the client ID from authentik.
    - Set **Client Secret** to the client secret from authentik.
    - Set **IDP Well-known Configuration Endpoint** to the value of the **OpenID Configuration URL** field in the authentik provider.
4. Click **NEXT**.
5. The values on the **Endpoint** page are fetched automatically from the **IDP Well-known Configuration Endpoint** set in the previous step. Confirm their accuracy, then click **NEXT**.
6. VMware Cloud Director requires the `openid`, `profile`, and `email` scopes, which are set by default. If you need other scopes, add them here. Otherwise, click **NEXT**.
7. The default **Claim Mapping** works fine, add any modifications you need and click **NEXT**.
8. On the **Key Configuration** page, VMware Cloud Director fetches the correct public key from the authentik Key Refresh Endpoint. Once the signing key expires, you must manually upload the new key, or you could toggle the **Automatic Key Refresh** option to on. You then need to set the **Key Refresh Period** and the **Key Refresh Strategy**. The different strategies are explained in the [VMware Cloud Director docs](https://techdocs.broadcom.com/us/en/vmware-cis/cloud-director/vmware-cloud-director/10-6/configure-your-system-to-use-an-openid-connect-identity-provider.html). Click **NEXT** to complete this step.
9. On the **Button Label** page, you are able to customize the label that's shown on the sign in page. Set a label of your choosing, then click **SAVE** to save the configuration and close the wizard.
10. It's necessary to link authentik groups to Cloud Director roles, otherwise Cloud Director will deny permissions to authentik users. Using the menu in the left navigation bar, navigate to **Administration** > **Provider Access Control** > **Groups**.

:::info Tenant configuration
If you're configuring the integration on a tenant-level in Cloud Director, navigate to **Administration** > **Access Control** > **Groups**.
:::

11. Click **IMPORT Groups** and set the following values:
    - Switch the **Source** dropdown to "OIDC"
    - The dialog now displays a large text area labeled **Enter the group names**. Use a new line for each group.
    - Select the Cloud Director role you wish to map to those authentik groups in the **Assign Role** dropdown.
    - Click **SAVE**.

## Configuration Verification

To verify the integration of authentik with VMware Cloud Director, log out of Cloud Director, then on the login page click the "Sign in with OIDC" button. If you specified a custom string on step 9, it is displayed instead. You will be redirected to authentik, and once authenticated, you will be logged in to Cloud Director.

## Resources

- [VMware Cloud Director Documentation - OIDC](https://techdocs.broadcom.com/us/en/vmware-cis/cloud-director/vmware-cloud-director/10-6/configure-your-system-to-use-an-openid-connect-identity-provider.html)
