Manage ID provider users with the ID provider
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. This guide gives an overview of how to set up your ID provider to work with users that do not have IBM Cloud® accounts. You can also view the full App ID documentation.
To manage users by using IBM Cloud, see one of these topics:
Steps
Follow these high-level steps to set up your environment:
-
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.
-
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.
-
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.
-
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.
-
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"}
); thecontains
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
-
A user is sent the ID provider URL for the IBM Cloud account.
NoteThe administrator can always go to Manage → Access (IAM) → Identity providers to look up the ID provider URL.
-
The user creates an API key by going to (Manage → Access (IAM) → API keys).
-
For further information, users can review Install Qiskit.
Example scenario
This example creates the following setup:
- There are two projects,
ml
andfinance
.- The
ml
project needs access to the service instancesQR-ml
andQR-common
. - The
finance
project needs access to the service instancesQR-finance
andQR-common
.
- The
- There are three users:
- Fatima needs access to the
ml
project. - Ravi needs access to the
finance
project. - Amyra needs access to both projects.
- Fatima needs access to the
- 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:
-
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.
-
The Cloud administrator creates three service instances:
QR-ml
,QR finance
, andQR-common
. -
The Cloud administrator creates a custom rule that includes the
quantum-computing.job.delete
action. -
The Cloud administrator creates two access groups:
- The
ml
access group can accessQR-ml
andQR-common
. This access group needs a dynamic rule for the App ID IDP that accepts users whoseproject
attribute containsml
. - The
finance
access group can accessQR-finance
andQR-common
. This access group needs a dynamic rule for the App ID IDP that accepts users whoseproject
attribute containsfinance
.
- The
-
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"}
.
- For Fatima, the custom attributes contain
-
Users log in through the ID provider URL, create API keys, and work with their projects' service instances.
Next steps
- See IBM Cloud SAML Federation Guide for more information.
- Refer to the full App ID documentation.