Common scenarios
Added by IBM contributorIBM | Edited by Claudia R Elbourn on June 8, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Learn about common scenarios for using IBM SmartCloud™ SaaS Business Support System (BSS) REST services and the tasks that are related to each scenario.

Table 1. Common scenarios and related tasks

BSS REST API category Common scenarios Sequence of related tasks
Customer management services Register a customer and then create a subscription for that customer.
  1. Register customer
  2. Create subscription for the customer
  Update the profile of a registered customer. Editable attributes include organization name, address, location, contact information, job title and more.
  1. Find Customer ID using Get customer list by email address or organization name API
  2. Get customer by ID
  3. Update customer profile
  4. Verify customer profile is updated using Get customer by ID API
  Suspend a registered customer. Suspended customers are moved out of active status and cannot use any services.
  1. Find Customer ID using Get customer list by email address or organization name API
  2. Suspend customer
  3. Verify customer is suspended using Get customer by ID API
  Unsuspend a suspended customer. This action returns customers to active status so they can use services again.
  1. Find customer ID using Get customer list by email address or organization name API
  2. Unsuspend customer
  3. Verify customer is unsuspended using Get customer by ID API
  Delete a customer organization and all the subscribers who are part of that organization.
  1. Find Customer ID using Get customer list by email address or organization name API
  2. Delete customer
  3. Verify customer is deleted using Get customer by ID API
  Get a list of all the customers in the vendor's organization.
  1. Get customer list
Subscription management services Suspend a subscription and its child subscriptions for a registered customer. Any subscribers who have a seat entitled to the subscription are suspended. However, any seat that is assigned to subscribers of the subscription remain in the assigned state.
  1. Find customer ID using Get customer list by email address or organization name API
  2. Find subscription ID using Get subscription list by customer ID API
  3. Suspend subscription
  4. Verify subscription is suspended using Get subscription by ID API
  Unsuspend a subscription and its child subscriptions for a registered customer. Any subscribers who have a seat entitled to the subscription are moved from suspended to active state.
  1. Find customer ID using Get customer list by email address or organization name API
  2. Find subscription ID using Get subscription list by customer ID API
  3. Unsuspend subscription
  4. Verify subscription is unsuspended using Get subscription by ID API
  Cancel a subscription for a registered customer. This action revokes access for all users who are entitled to the subscription. Note that canceled subscriptions still exist in the system until you delete the customer.
  1. Find customer ID using Get customer list by email address or organization name API
  2. Find subscription ID using Get subscription list by customer ID API
  3. Cancel subscription
  4. Verify subscription is cancelled using Get subscription by ID API
  Update a subscription for a registered customer to change the expiration date or the number of available seats.
  1. Find subscription ID using Get subscription list by customer ID API
  2. Get subscription by ID
  3. Update subscription
  4. Verify the subscription is updated using Get subscription by ID API
  Get a list of subscriptions for all the vendor's customers.
  1. Get subscription list
Subscriber management services Add a subscriber either to the vendor's organization or to the organization of one of the vendor's customers.
  1. Find customer ID usingGet customer list by email address or organization name API
  2. Add subscriber
  3. Verify subscriber is added using Get subscriber by ID API
  Entitle a subscriber to a newly created subscription. This action assigns a seat for the subscriber in the subscription.
  1. Register customer
  2. Create subscription for the customer
  3. Add subscriber for the customer
  4. Entitle subscriber to the new subscription
  Entitle a subscriber to an existing subscription. This action assigns a seat for the subscriber in the subscription.
  1. Find subscription ID using Get subscription list by customer ID API
  2. Find subscriber ID usingGet subscriber list by customer ID API
  3. Entitle subscriber
  Get a list of all the subscribers in the vendor's organization.
  1. Get subscriber list
  Update the profile of a registered subscriber. Update details such as name, location, and contact information.
  1. Find subscriber ID using Get customer list by email address or organization name API
  2. Get subscriber by ID
  3. Update subscriber profile
  4. Verify the subscriber profile is updated usingGet subscriber by ID API
  Suspend a subscriber. Suspended subscribers are no longer active and cannot use services to which they are entitled.
  1. Find subscriber ID using Get customer list by email address or organization name API
  2. Suspend subscriber
  3. Verify the subscriber is suspended using Get subscriber by ID API
  Unsuspend a subscriber. This action returns subscribers to active state so they can use the services to which they are entitled.
  1. Get customer list by email address or organization name
  2. Unsuspend subscriber
  3. Get subscriber by ID
  Delete a subscriber from a subscription. This action removes subscribers from their assigned seats in the subscription. The subscriber must be owned by the organization of the authenticated user.
  1. Find subscriber ID using Get customer list by email address or organization name ID
  2. Delete subscriber
  3. Verify the subscriber is deleted using Get subscriber by ID API
  Revoke a subscriber from a given subscription. When revoking subscribers, the seats that they currently occupy in the subscription become available. This action does not delete subscribers from the system, however.
  1. Find subscriber ID using Get customer list by email address or organization name API
  2. Get subscription by ID
  3. Revoke subscriber
  4. Verify the subscriber is revoked using Get subscriber by ID API
Authentication services Change the password of a subscriber. The current password must be available to perform this action.
  1. Change password
  Reset the password for a subscriber when the current password is not available. Subscribers are forced to change their reset passwords the next time they log in.
  1. Reset password