Revoke subscriber
Added by IBM contributorIBM | Edited by Claudia R Elbourn on June 15, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

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.

The API caller must have one of the following roles to run the API:

  • DataMigrator
  • ContentValidator
  • eDiscovery_User
  • eDiscovery_Admin
  • UserAccountAssistant
  • VSR
  • CustomerAdministrator

Table 1. API details
Method
Resource address
Operation header
POST
resource/subscriber/<subscriber_id>/seat/<seat_id>?_force=<true | false>
x-operation: revokeSubscriber
 

URL parameters


Provide the following parameters.

Table 2. Parameters

Parameter
Required
Description
subscriber_id
Yes
The ID of the subscriber. To obtain the ID, see the Get subscriber list by email address and Get subscriber list by customer ID topics.
seat_id
Yes
The ID of the seat that is being revoked. To obtain the ID, see the Get subscriber list by email address and Get subscriber list by customer ID topics.
_force
No
The default value is false. Set to true only if the user goes into a bad state and needs to be forcefully cleaned up. If set to true, no events are sent to service endpoints, and the user’s seat is not freed up.
For a list of common HTTP status codes that are returned for API calls, see HTTP status codes.


Parent topic: Subscriber management services

 

Input
Method URI Description
POST /api/bss/resource/subscriber/{subscriber_id}/seat/{seat_id} 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.
The API caller must have one of the following roles to run the API:
CustomerAdministrator
User
VSR
Content Type: text/plain
Name Type Optional Description
subscriber_id
string No The ID of the subscriber.
seat_it
string No The ID of the seat that is being revoked.
Name Type Optional Description
_force
boolean No The default value is false. Set to true only if the user goes into a bad state and needs to be forcefully cleaned up. If set to true, no events are sent to service endpoints, and the user’s seat is not freed up.
Name Type Optional Description
x-operation
string No revokeSubscriber