Previous Topic: Fetching Directory Service AttributesNext Topic: Managing Additional User Configurations


Deleting Organizations

The deleteOrg operation is used to delete organizations. After you delete an organization, the information related to that organization is still maintained in the system. Therefore, you cannot create an organization with the same name as that of the deleted organization.

This section walks you through the following steps for deleting organizations:

Note: After you delete an organization, you must refresh the system cache for the changes to take effect. See "Refreshing the Organization Cache" for more information on how to refresh the system cache.

Preparing the Request Message

The deleteOrgRequest message is used to delete organizations. The following table lists the elements of this request message.

Element

Mandatory

Description

orgName

Yes

The unique name with which the organization is identified.

clientTxId

No

Unique transaction identifier that your calling application can include. This identifier helps in tracking the related transactions.

Invoking the Web Service

To delete organizations:

  1. (Optional) Include the authentication and authorization details in the header of the deleteOrg operation. See "Managing Web Services Security" for more information on the header elements.
  2. Use the deleteOrgRequest elements for fetching the organization details, as listed in the table.
  3. Use the deleteOrgRequest message and construct the input message by using the details specified in the preceding step.
  4. Invoke the deleteOrg operation of the ArcorUserRegistryMgmtSvc service to delete the organization.

    This operation returns the deleteOrgResponse message that includes the transaction identifier, authentication token, and organization details. See the following section for more information on the response message.

Interpreting the Response Message

The response message, deleteOrgResponse, returns the transaction identifier and the authentication token in the SOAP envelope header. These elements are explained in the following table. The SOAP body returns a success message if the operation was performed successfully. If there are any errors, then the Fault response is returned. See appendix, "Exceptions and Error Codes" for more information on the SOAP error messages.

Element

Description

udsTransactionID

The unique identifier of the transaction performed by using UDS.

authToken

The authentication token that is returned if the credential verification to access the Web service was successful. This token eliminates the need for you to present the authentication credential for successive access to the Web service.

By default, the authentication token is valid for one day, after which you need to authenticate again.