CA API Gateway 9.1

9.4 9.1

Capture Identity of Requestor Assertion

The Capture Identity of Requestor assertion is used to determine the identity of a requestor (that is, the customer) for auditing or reporting using any of the following methods:
gateway90
The
Capture Identity of Requestor
assertion is used to determine the identity of a requestor (that is, the customer) for auditing or reporting using any of the following methods:
  • By capturing the requestor's IP address
  • By capturing the requestor's authenticated User ID (where available)
  • By capturing the value from a context variable that contains identifying information about the requestor (for example, from a context variable created by the Evaluate Request XPath, Evaluate Response XPath, or Evaluate Regular Expression assertions, or a context variable that extracts information from the HTTP header)
You can define up to five mappings in a Capture Identity of Requestor assertion, however there can only be a maximum of five distinct mappings per policy, regardless of how many assertions are present. A "distinct mapping" is defined as follows:
  • Each context message mapping consists of three parts:
    Type, Key, Value
  • Mappings are distinct if their Types differ OR if the Type is the same, the Keys differ
Example 1:
 These mappings are distinct:
Mapping 1:
 IP Address, IP_ADDRESS (SYSTEM DEFINED)
Mapping 2:
 Custom Mapping, My_Value, Gold_Medal
Example 2:
 These mappings are also distinct:
Mapping 1:
 Custom Mapping, Value_A, Gold_Medal
Mapping 2:
 Custom Mapping, Value_B, Gold_Medal
The information that is captured can be viewed in the [Details] tab of the Gateway Audit Events window:
MessageContext_AuditDetails.png
Viewing message context mappings in the Gateway Audit Events window
Using the Assertion
  1. Do one of the following:
    • To add the assertion to the Policy Development window, see Add an Assertion.
    • To change the configuration of an existing assertion, proceed to step 2 below.
  2. Right-click
    Capture Identity of Requestor
    in the policy window and select
    Requestor Identity Properties
     or double-click the assertion in the policy window. The assertion properties are displayed.
  3. Configure the properties as follows:
    To...
    Do this...
    Add a message context mapping
    1. Click [
      Add
      ]. The Configure Message Context Mapping dialog appears. You can add a maximum of five mappings per Capture Identity of Requestor assertion.
    2. Select the mapping
      Type
      :
      • IP Address:
         Obtain the identity from the customer's IP address.
      • Authenticated User:
         Obtain the identity from the customer's authenticated User ID.
      • Custom Mapping:
         Obtain the identity using a custom mapping defined in the Key and Value fields.
    3. In the
      Key
       field, enter a string of text (no spaces) to identity your custom mapping. The key cannot be changed when using the
      IP Address
       or
      Authenticated User
       types.
    4. In the
      Value
       field, specify a context variable that holds identifying information about the requestor.
      The following are examples of context variables that you can use:
      • ${request.username}
      • ${request.authenticateduser}
      • a context variable created by an XPath assertion (Evaluate Request XPath or Evaluate Response XPath)
      • a context variable created by the Evaluate Regular Expression assertion
      • a context variable that returns information from the HTTP header
      You can add descriptive text to the variable name to make it easier to read. For example, "High Value Customer: ${request.username}".
      The value cannot be changed when using the
      IP Address
       or
      Authenticated User
       types.
    Remove a message context mapping
    1. Select the mapping to be removed. The last mapping cannot be removed.
    2. Click [
      Remove
      ].
    Edit a message context mapping
    1. Select the mapping to be edited.
    2. Click [
      Properties
      ]. The Configure Message Context Mapping dialog appears.
    3. Edit the fields as necessary. The
      Key
       and
      Value
       fields cannot be edited for system defined types.
    4. Click [
      OK
      ] when done.
  4. Click [
    OK
    ] when done.

Content feedback and comments