Previous Topic: Updating Organization StatusNext Topic: Fetching Default Organization Details


Refreshing the Organization Cache

The refreshCache operation is used to refresh the organization configurations that are stored in the cache. This section walks you through the following topics for refreshing the organization cache:

Preparing the Request Message

The refreshCacheRequest is used to refresh the organization cache. The following table lists the elements of this request message:

Element

Mandatory

Description

systemCache

No

Specify whether you want to refresh all the cache of the AuthMinder setup. Possible values are:

  • True: Indicates that all the cache, which includes all organizations and server cache.
  • False: If you select this option, then you can refresh the organization cache, by selecting allOrganization or OrgName.

Note: You can set any one of the following elements.

allOrganizations

No

Specifies whether the cache of all organizations has to be refreshed. Set the value of this element to TRUE to refresh the cache of all organizations.

OrgName

Yes

The unique name with which the organizations are identified.

clientTxId

No

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

Invoking the Web Service

To refresh the organization cache:

  1. (Optional) Include the authentication and authorization details in the header of the refreshCache operation. See chapter, "Managing Web Services Security" for more information on the header elements.
  2. Use the refreshCacheRequest elements for updating the organization configurations.
  3. Use refreshCacheRequest message and construct the input message by using the details obtained in preceding step.
  4. Invoke the refreshCache operation of the ArcorUserRegistryMgmtSvc service to refresh the organization cache.

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

Interpreting the Response Message

The response message, refreshCacheResponse, 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, "Error Codes" for more information on the SOAP error messages.

Element

Description

udsTransactionID

The unique identifier of the transaction that is performed using UDS.

authToken

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

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