Previous Topic: Assigning Default ConfigurationsNext Topic: Checking Key Availability in HSM

CA AuthMinder Web Services Guide › Managing AuthMinder Configurations › Fetching Server Events

Fetching Server Events

The FetchEventDetailsRequest message is used to fetch events that are used to invoke a configured plug-in.

This section walks you through the following topics for fetching configuration details:

Preparing the Request Message

The FetchEventDetailsRequest message is used to fetch events. The following table lists the common elements of this request message that are applicable to all credentials:

Element

Mandatory

Description

clientTxId

No

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

Additional Input (additionalInput) Elements

pairs

No

Fetches additional inputs defined to augment AuthMinder’s user issuance capability using plug-ins, write completely new custom user issuance methods, or track transactions end-to-end.

In all of these cases, the extra information is set in name-value pairs.

  • name

Indicates the name used to create the key pair.

  • value

Indicates the corresponding value for the name.

 

Organization Detail (orgDetails) Elements

orgName

Yes

Deletes the name of the organization to which you applied the configuration settings.

OR

isGlobal

Yes

Indicates if you want to apply these configuration settings at the global level.

Invoking the Web Service

To fetch event details:

  1. (Optional) Include the authentication and authorization details in the SOAP header or in the additionalInput element of the fetchServerEvents operation. See chapter, "Managing Web Services Security" for more information on these details.
  2. Use the FetchServerEventsRequest elements to fetch event details, as listed in the preceding table.
  3. Use the FetchServerEventsRequest message and construct the input message by using the details obtained in the preceding step.
  4. Invoke the fetch operation of the ArcotWebFortAdminSvc service to fetch the event details.

Interpreting the Response Message

For successful transactions, the response message, fetchResponse returns the elements explained in the following table. These elements are included in the SOAP body. If there are any errors, then the Fault response is included in the SOAP body. See appendix, "Error Codes" for more information on the SOAP error messages.

Element

Description

message

Indicates the status of the transaction.

reasonCode

Unique code that is sent by AuthMinder Server if the operation fails.

responseCode

Code returned by the SDK in case of errors.

transactionID

The unique identifier of the transaction.