About API Mappers
    • 24 Nov 2024
    • 1 Minute to read
    • Dark
      Light
    • PDF

    About API Mappers

    • Dark
      Light
    • PDF

    Article summary

    The API Mappers define the relation between Applications, Asset Types, and Identity Sources in the Authorization Platform to the APIs used to access or use the business applications of the Organization. This allows users to gain better control over values used for specific API access flows, reducing unnecessary data fetching and improving performance. To view the API Mappers associated to an Application, click on the Application in the Authorization Workspace and select the API Mappers tab.

    When working with API Mappers, the following basic workflow can be followed:

    • Create an Application for example, an External Bank Portal application in the Authorization Platform)
    • Create the Asset Types relevant for defining the Assets of the Bank (for example, Account, Loan Applications, etc.)
    • Create an Identity Source to define where the Identity information for Authorization decisions is retrieved.
    • Add an API Mapper
    • Associate the Asset Type to the API Mapper
    • Defining the Attribute Mapping Logic
    • Prioritize the API Mappers

    API Mappers within the Authorization Platform are created for and must be unique in an Application (click on an Application and select the API Mappers tab).

    In addition to a Name and Description (optional), each API Mapper is assigned:

    • Match Pattern, a unique value which maps and caches the API URL, allowing the Authorization Platform to access and use it. Using an asterisk (*) as a wildcard character, the Match Pattern applies to all subfolders (for example: /api/v1/account/accounts/* refers to contents within the accounts directory and subdirectories).

    • Asset Types, which determines which Asset Type (or Asset Types) are associated with this Mapper (for example: Loan, Account means that the API Mapper is associated with Asset Types Loan and Account).

    Both of these values are required.

    For more information, see Managing API Mappers.


    Was this article helpful?