Managing your Watson Speech services instances

After you install the Watson Speech services and provision a service instance, you can perform tasks such as granting access to the instance to individual users and listing and deleting instances.

Permissions you need for this task:
You must be an administrator of the Red Hat® OpenShift® project to manage service instances.

Service instance management topics

For more information about managing Watson Speech services instances, see the following topics:

Managing user access

After you provision an instance of a Speech service, you can share the URL for the service with other users. However, those users can log in to the service only if you give them access.

If you plan to use the Security Assertion Markup Language (SAML) for single sign-on (SSO), complete the procedure in Configuring single sign-on before you add users. If you add users before you configure SSO, you need to re-add the users with their SAML IDs to enable them to use SSO. For more information, familiarize yourself with the steps that are outlined in Managing IBM Cloud Pak® for Data users.

To add users to a service instance, complete the following steps:

  1. From the IBM Cloud Pak for Data web client menu, click Administer > Manage user.
  2. Click Add user, then specify the user's full name, user name, and email address. Set the user's permissions, and then click Add.
  3. From the web client menu, select My Instances.
  4. Find your service instance, click the more (...) menu, and then choose Manage Access.
  5. Click Add user.
  6. Click the user name field to see a list of the people you can add.
  7. The users that are returned by the previous step are listed. Select a name, choose User or Admin as their access role, and then click Add.

If you are not connected to an existing user registry and have not enabled single sign-on (SSO), temporary passwords are created for the users that you add. The temporary passwords are sent to the users at the email addresses that you specify.

Managing service instances with the API

The following operations use the API to manage service instances. For more information about using the API to create a service instance, see Creating a service instance with the API.

Prerequisite step

Before you can use the API, you must get an API key that you can use to obtain a token that you can pass with the API requests. Follow the steps that are described in Authentication in IBM Cloud Pak for Data Platform API.

In the following requests, replace the variables with the following values:
<host>
The hostname for the Cloud Pak for Data cluster.
<token>
The authorization token that you obtained when you completed the prerequisite step.

Listing service instances

The following example lists the Cloud Pak for Data service instances:

curl --request GET \
  --header "Authorization: Bearer <token>" \
  --url https://<host>/zen-data/v3/service_instances

Deleting a service instance

The following example deletes the service instance that you specify by its instance ID:

curl --request DELETE \
  --header "Authorization: Bearer <token>" \
  --url https://<host>/zen-data/v3/service_instances/<instance_id>

Managing service instances with the CLI

The following operations use the command-line interface (cpd-cli) to manage service instances. For more information about using the CLI to create a service instance, see Creating a service instance with the CLI.

Prerequisite step

The following command's require the Cloud Pak for Data configuration profile name that has permission to provision instances. For more information, see Creating a profile to use the cpd-cli management commands.

Listing service instances

The following example lists the Cloud Pak for Data service instances that are associated with the specified profile:

cpd-cli service-instance \
--profile <cpd-configuration-profile-name> list

Getting a service instance

The following example returns information about the service instance that you specify by name:

cpd-cli service-instance \
--profile <cpd-configuration-profile-name> get <instance-name>

Deleting a service instance

The following example deletes the service instance that you specify by name:

cpd-cli service-instance \
--profile <cpd-configuration-profile-name> delete <instance-name>