Deleting a Tenant by using Webservice

This section shows you a configuration webservice, which allows you to delete a tenant from the participants.

Access the URL below to delete a tenant.

http://xxxxx/TAFJConfiguration/resources/configuration/tenant/{configuration_ID}/{tenant_Id}

Where,

  • configuration_ID - The configuration ID which you want to add the tenant as a participant.
  • tenant_Id - The tenant ID for the tenant to add to configuration.
ClosedExample

To delete a tenant identified with tenant1 from a configuration named master, use the following DELETE request:

curl --request DELETE \
--url http://localhost:8080/TAFJConfiguration/resources/configuration/tenant/master/tenant1

In case of successful response, the service returns an HTTP code 204 no content.

Deleting a tenant doesn’t delete the underlined tenant configuration since a tenant definition can be used in multiple system configurations. It simply removes the tenant definition from the available participants list of the configuration where the deletion has been performed.

To delete a tenant configuration permanently, the underlined tenant configuration post the following DELETE request, where the configurationID is the tenantId:

http://xxxxx/TAFJConfiguration/resources/configuration/{configuration_ID} 

curl --request DELETE \
--url http://localhost:8080/TAFJConfiguration/resources/configuration/tenant1

For more information regarding the configuration web service, see Configuration Management – REST API.

NOTE: System must be restarted after configuration change, if it is already running.

Bookmark Name Actions
BACK

In this topic

Feedback
x

Are you sure you want to log-off?