Skip to main contentIBM Quantum Documentation Preview
This is a preview build of IBM Quantum™ documentation. Refer to docs.quantum.ibm.com for the official documentation.

Manage ID provider users

Note

This documentation is relevant to the new IBM Quantum® Platform. If you need the previous version, return to the IBM Quantum Platform Classic documentation.

App ID creates an ID provider so you can add users directly in App ID or connect to other external ID providers. The following sections give an overview of how to set up your ID provider to work with users that do not have IBM Cloud® accounts, as well as those that do have IBM Cloud accounts. You can also view the full App ID documentation.

Manage ID provider users with the ID provider

Follow these high-level steps to set up your environment:

  1. Create an App ID instance.

  2. Configure the ID provider.

    • Use the Cloud Directory capability to add users to the ID provider. Open the IBM Cloud resource list, search for your App ID instance and click its name to edit its details.
    • Refer to the App ID documentation for instructions how to integrate other ID providers into App ID.

  3. Integrate the App ID instance as the ID provider for the administrator's account on the Identity Providers page. See Managing authentication for full details.

    After enabling enable the ID provider, default IdP URL is shown. Share this URL with users when they need to log in.

  4. Add a dynamic rule to the access group. This rule tests whether it should be applied to an ID provider (IDP) user when they log in.

    Because the dynamic rules are evaluated during login, any changes are picked up the next time the user logs in.

  5. Add users. When you use App ID as ID provider with the Cloud directory, you can create users in the Cloud user interface from the resource list.

  6. Create or modify users' project assignments by adding them as custom attributes.

    Enter a key value pair that will checked by the dynamic rules of the access groups. You can add several values in the same string (for example, {"project":"ml finance"}); the contains qualifier of the dynamic rule detects a match of a substring.

    If you don't see the user that you want to manage, verify that they logged in to IBM Cloud at least once.

User flow

  1. A user is sent the ID provider URL for the IBM Cloud account.

    Note

    The administrator can always go to Manage → Access (IAM) → Identity providers to look up the ID provider URL.

  2. The user creates an API key by going to (Manage → Access (IAM) → API keys).

  3. For further information, users can review Install Qiskit.

Example scenario

This example creates the following setup:

  • There are two projects, ml and finance.
    • The ml project needs access to the service instances QR-ml and QR-common.
    • The finance project needs access to the service instances QR-finance and QR-common.
  • There are three users:
    • Fatima needs access to the ml project.
    • Ravi needs access to the finance project.
    • Amyra needs access to both projects.
  • It uses access groups without resource groups.
  • Users are defined in an App ID instance and project assignments are also done there.
  • Users should be able to delete jobs.

The steps to implement this setup are:

  1. The Cloud administrator creates an App ID instance and ensures that it is linked in the Cloud administrator's account. The administrator notes the ID provider URL to share it with users.

  2. The Cloud administrator creates three service instances: QR-ml, QR finance, and QR-common.

  3. The Cloud administrator creates a custom rule that includes the quantum-computing.job.delete action.

  4. The Cloud administrator creates two access groups:

    • The ml access group can access QR-ml and QR-common. This access group needs a dynamic rule for the App ID IDP that accepts users whose project attribute contains ml.
    • The finance access group can access QR-finance and QR-common. This access group needs a dynamic rule for the App ID IDP that accepts users whose project attribute contains finance.

  5. The IDP administrator uses the App ID instance that the Cloud administrator created and defines the three users:

    • For Fatima, the custom attributes contain {"project":"ml"}.
    • For Ravi, the custom attributes contain {"project":"finance"}.
    • For Amyra, the custom attributes contain {"project":"ml finance"}.

  6. Users log in through the ID provider URL, create API keys, and work with their projects' service instances.

Manage ID provider users with IBM Cloud

Follow these high-level steps to set up your environment:

  1. Create an App ID instance.

  2. Configure the ID provider.

    • Use the Cloud Directory capability to add users to the ID provider. Open the IBM Cloud resource list, search for your App ID instance and click its name to edit its details.
    • Refer to the App ID documentation for instructions how to integrate other ID providers into App ID.

  3. Integrate the App ID instance as the ID provider for the administrator's account on the Identity Providers page. See Managing authentication for full details.

    After enabling enable the ID provider, default IdP URL is shown. Share this URL with users when they need to log in.

  4. Add users. When you use App ID as ID provider with the Cloud directory, you can create users in the Cloud user interface from the resource list.

  5. Create or modify users' project assignments from the IAM user page.

    If you don't see the user that you want to manage, verify that they logged in to IBM Cloud at least once.

  6. Add or modify users' access groups from the IAM user page.

User flow

  1. A user is sent the ID provider URL for the IBM Cloud account. They use this URL and the login information to access the system. The user should change their password after they log on.

    Note

    The administrator can always go to Manage → Access (IAM) → Identity providers to look up the ID provider URL.

  2. The user create an API key from (Manage → Access (IAM) → API keys).

  3. For further information, users can review Install Qiskit.

Example scenario

This example creates the following setup:

  • There are two projects, ml and finance.
    • The ml project needs access to the service instances QR-ml and QR-common.
    • The finance project should have access to the service instances QR-finance and QR-common.
  • There are three users:
    • Fatima needs access to the ml project.
    • Ravi needs access to the finance project.
    • Amyra needs access to both projects.
  • It uses access groups without resource groups.
  • Users are defined in IBM Cloud but project assignments are done in an App ID instance.
  • Users should be able to delete jobs.

The steps to implement this setup are:

  1. The Cloud administrator creates an App ID instance and ensures that it is linked in the Cloud administrator's account. The administrator notes the ID provider URL to share it with users.

  2. The Cloud administrator creates three service instances: QR-ml, QR finance, and QR-common.

  3. The Cloud administrator creates a custom rule that includes the quantum-computing.job.delete action.

  4. The Cloud administrator creates two access groups:

    • The ml access group can access QR-ml and QR-common. This access group needs a dynamic rule for the App ID IDP that accepts users whose project attribute contains ml.
    • The finance access group can access QR-finance and QR-common. This access group needs a dynamic rule for the App ID IDP that accepts users whose project attribute contains finance.

  5. The ID provider administrator defines the three users in the IBM Cloud user interface.

  6. Users log in at least once.

  7. The cloud administrator assigns access by adding users to the access groups that give them access to the projects:

    • Fatima is given access to the ml project.
    • Ravi is given access to the finance project.
    • Amyra is given access to the ml and finance projects.

  8. Users can log in through the ID provider URL, create API keys, and work with their projects' service instances.

Next steps

Recommendations