`manage setup-iam-integration`

Important: IBM Cloud Pak® for Data Version 4.7 will reach end of support (EOS) on 31 July, 2025. For more information, see the Discontinuance of service announcement for IBM Cloud Pak for Data Version 4.X.

Upgrade to IBM Software Hub Version 5.1 before IBM Cloud Pak for Data Version 4.7 reaches end of support. For more information, see Upgrading IBM Software Hub in the IBM Software Hub Version 5.1 documentation.

Specify whether you want to use the IBM Cloud Pak foundational services IAM Service to connect to your identity provider (IdP).

Extended description

After you install the IBM Cloud Pak for Data control plane, you can integrate with the Identity Management Service (Identity Management Service) provided by IBM Cloud Pak foundational services.

For more information about the benefits and drawbacks of integrating with the Identity Management Service, see Integrating with the Identity Management Service.

Important: Make the decision about whether you want to use the Identity Management Service before you grant users access to the platform.

It is possible to migrate users from the Cloud Pak for Data user management service to the Identity Management Service, however, you cannot migrate users from the Identity Management Service to the Cloud Pak for Data user management service. Switching between the user management methods might prevent users from accessing objects or services on the platform.

Run the setup-iam-integration to enable or disable an integration with the Identity Management Service.

Syntax

cpd-cli manage setup-iam-integration \
--enable=true \
--cpd_instance_ns=<project-name>

Arguments

The setup-iam-integration command has no arguments.

Options

Option	Description
`--cpd_instance_ns`	The project (namespace) where IBM Cloud Pak for Data is installed. Status Required. Syntax `--cpd_instance_ns=<project-name>` Default value No default. User-defined. Valid values The project (namespace) where IBM Cloud Pak for Data is installed.
`--enable`	Specify whether you want to integrate with the IAM service. Status Required. Syntax `--enable=true` Default value No default. Valid values true Enable integration with the Identity Management Service service. After you enable integration with the Identity Management Service, see Connecting to your identity provider for information on how to connect to your identity providers.

Table 1: Command options

Examples

Note: The following example uses the recommended installation environment variables.

Use a script to create environment variables with the correct values for your environment. For details, see Best practice: Setting up install variables.

Integrate with the Identity Management Service

cpd-cli manage setup-iam-integration \
--enable=true \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}