IBM Cloud Pak for Data Platform API

Create and manage user accounts, user groups, roles, events, vaults, cards, and volumes on IBM® Cloud Pak for Data by using the Cloud Pak for Data REST API. Introduction As an administrator, you are responsible for determining and implementing the best approach for authenticating and managing the Cloud Pak for Data platform. You can perform the following tasks by using the Cloud Pak for Data REST API: Manage user and user group permissions : A Cloud Pak for Data administrator can create and manage roles, which grant permissions to users and groups on the platform. : A user can have multiple roles. The roles can be assigned directly to a user or can be assigned to the user through a user group. If a user has multiple roles, the user has all of the permissions from all of the roles that are assigned to them. : User groups make it easier to manage many users with similar access requirements. For example, if you know that 20 different users are going to collaborate on a project and they all need the Data steward role, you can add them to a group that is assigned the Data steward role. If a member of the group leaves the company, you can remove the user from the group, rather than look for and update all of the assets that the user has access to. Create and manage user profiles : Authenticated users can perform tasks such as updating their own user-profile information, generating an API key, or changing their password. : A Cloud Pak for Data administrator with the administrator or manageusers permissions can also create, update, or delete user-profiles. Manage service instances : A Cloud Pak for Data administrator with the Create service instances permission can create, retrieve, and delete service instances. Configure monitors and alerts : A Cloud Pak for Data administrator can browse generated events and configure monitors and alerts. Create custom cards for the home page : Administrators can create custom cards to display key performance indicators on the Cloud Pak® for Data home page. Manage secrets and vaults : Authenticated users can safeguard credentials and secrets with access control and audit logging by using vaults. Manage persistent volume instances : Administrators with the Create service instances permission can create and manage persistent volume instances on your existing Cloud Pak® for Data storage devices. Authentication <-- -- To authenticate to the API, pass an access token or platform API key token in an Authorization header. Using Authorization: ZenApiKey token With a platform API key, you can access everything that you would typically be able to access when you log in to the Cloud Pak for Data web client. To generate a platform API key through the user experience: 1. Log in to the web client. 2. From the toolbar, click your avatar. 3. Click Profile and settings. 4. Click API key Generate new key. 5. Click Generate. 6. Click Copy and save your key somewhere safe. You cannot recover this key if you lose it. Alternatively, you can call the Generate API keyhttps://cloud.ibm.com/apidocs/cloud-pak-data/cloud-pak-data-5.0.0getapikey method. Note: this method must be called with bearer access token authorization. When you get the API Key from the user experience or from the generate API Key method, you must Base64 encode