Uploaded image for project: 'OpenAM'
  1. OpenAM
  2. OPENAM-16869 Improve Scripting documentation
  3. OPENAM-14934

it's not mentioned which type objects are returned by / provided to script objects

    Details

    • Type: Doc Sub-Task
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: 13.0.0, 13.5.0, 13.5.1, 13.5.2, 14.0.0, 14.1.0, 14.1.1, 14.5.0, 14.5.1, 5.5.1, 6.0.0, 6.0.0.1, 6.0.0.2, 6.0.0.3, 6.0.0.4, 6.0.0.5, 6.5.0, 6.0.0.6, 6.5.0.1, 6.5.1, 6.5.0.2
    • Fix Version/s: None
    • Component/s: documentation
    • Labels:

      Description

      Bug description

      Documentation does not exactly tell which object types are provided / returned in scripts

      How to reproduce the issue

      1. Read documentation , e.g. https://backstage.forgerock.com/docs/am/6.5/authentication-guide/#scripting-api-global-http-client, https://backstage.forgerock.com/docs/am/6.5/authentication-guide/#scripting-api-authn
      Expected behaviour
      It should be documented that Java Objects are returned / provided to the scripts, even when a JavaScript is set as type of script. The full Java Class name should be documented.
      
      Current behaviour
      E.g. only the following is stated ...
       Server-side authentication scripts can access profile data through the methods of the idRepository object.
      

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                Unassigned
                Reporter:
                bthalmayr Bernhard Thalmayr
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated: