Uploaded image for project: 'OpenAM'
  1. OpenAM
  2. OPENAM-12738

SSOADM Script Name and ID should be more clear

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 5.5.1, 6.0.0
    • Fix Version/s: 6.0.0
    • Component/s: documentation
    • Labels:
    • Target Version/s:

      Description

      Referring to https://backstage.forgerock.com/docs/am/5.5/dev-guide/#managing-scripts-cli 

      Create an AM script as follows:

      Create a script configuration file as follows:

      script-file=/path/to/script-file
      language=JAVASCRIPT|GROOVY
      name=myScript
      context=AUTHENTICATION_SERVER_SIDE|AUTHENTICATION_CLIENT_SIDE|POLICY_CONDITION|OIDC_CLAIMS

      Run the ssoadm create-sub-cfg command. The --datafile argument references the script configuration file you created in the previous step:
       

      $ ssoadm \ 
      create-sub-cfg \ 
      --realm /myRealm \ 
      --adminid amadmin \ 
      --password-file /tmp/pwd.txt \ 
      --servicename ScriptingService \ 
      --subconfigname scriptConfigurations/scriptConfiguration \ 
      --subconfigid myScript \ 
      --datafile /path/to/myScriptConfigurationFile
      
      Sub Configuration scriptConfigurations/scriptConfiguration was added to realm /myRealm

       

      Note:

      name=myScript
      --subconfigid myScript \ 

      which means script name = script ID = myScript

      It's best if we can have these values different + description of these 2. For example subconfigid value can be myScriptID and name in the scriptconfig as myScriptName

      This is quite useful because the guide is using the get-sub-cfg afterwards with scriptConfiguration/myScript:

      $ ssoadm \ 
      get-sub-cfg \ 
      --realm /myRealm \ 
      --adminid amadmin \ 
      --password-file /tmp/pwd.txt \ 
      --servicename ScriptingService \ 
      --subconfigname scriptConfigurations/myScript* 

      In fact, this is the script ID, not the script name.

        Attachments

          Activity

            People

            • Assignee:
              chris.lee Chris Lee
              Reporter:
              anastasios.kampas Tasos Kampas
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: