manage setup-iam-integration

Use the IBM Cloud Pak® foundational services Identity Management Service to connect to your identity provider (IdP).

Extended description

When you install Cloud Pak for Data, the Identity Management Service is automatically enabled.

However, if you upgrade from an older release of Cloud Pak for Data and the Identity Management Service is not enabled, you can use the setup-iam-integration command to integrate Cloud Pak for Data with the Identity Management Service provided by IBM Cloud Pak foundational services.

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 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

Table 1: Command options
Option Description
--cpd_instance_ns The project (namespace) where IBM Software Hub is installed.
Status
Required.
Syntax
--cpd_instance_ns=<project-name>
Default value
No default. User-defined.
Valid values
The project (namespace) where IBM Software Hub is installed.
--enable Specify whether you want to integrate with the IAM service.
Status
Required.
Syntax
--enable=true
Default value
true
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.

Examples

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

It is strongly recommended that you use a script to create environment variables with the correct values for your environment. For details, see Setting up installation environment variables.

Integrate with the Identity Management Service
cpd-cli manage setup-iam-integration \
--enable=true \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}