[OPENAM-11813] Amster documentation needs improving Created: 21/Sep/17  Updated: 24/Sep/19  Resolved: 24/Sep/19

Status: Resolved
Project: OpenAM
Component/s: documentation
Affects Version/s: 14.0.0
Fix Version/s: None

Type: Improvement Priority: Major
Reporter: Dom Reed Assignee: Unassigned
Resolution: Won't Do Votes: 1
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Support Ticket IDs:


I have been trying to figure out how to construct an Amster command in order to update a single field so I could update a KB article. It has taken a lot of trial and error and in the end, the thing that moved me forward the most was the example given in the :help update command that showed the --body part enclosed in single quotes.

Few things in particular to note:

  • I did not find the schema information helpful in the Entity guide for Updates. If you do a Read first, you get the correct format.
  • There are no examples in the Entity guide to get you started. I noticed Andrew encountered similar usability issues: OPENAM-10909
  • I found it hard to work out which entity I needed to read/update. The Global Services Configuration section in the Reference guide gives the amster type ID, which is good but they don't all exactly correlate with an entity ID (plus it would be good to call them entity IDs). But the Reference section in Authentication and Single Sign-On Guide for authentication modules and core authentication attributes only gives ssoadm service & attribute names, which are different eg To enable the Use Stateless Sessions option, you use the iPlanetAMAuthService and openam-auth-stateless-sessions property with ssoadm but in Amster it is Authentication and statelessSessionsEnabled - I only found this by grepping the export for stateless! 

We are starting to get customers asking how to do things using Amster so this is likely to become a ticket generator. I have meanwhile put together a KB article on using Amster to update properties.


Note: It would be extremely helpful to give both ssoadm and Amster details in the reference guides until ssoadm is removed from the product.

Comment by Gene Hirayama [ 03/Nov/17 ]

Reassigning to Cris.

Comment by Chris Lee [ 24/Sep/19 ]

Update: We've managed to do some lookups and matching in the source code to map auth module attributes between Amster and ssoadm, so that both appear (6.5.x and 7).

e.g. https://ea.forgerock.com/docs/am/authentication-guide/index.html#authn-core-general

We don't have the time or resources to completely deal with some of the points in this Jira however, so will mark the Jira as wont do, even though we've address the request for having both ssoadm and amster attributes alongside each other, where able.

Generated at Sun Sep 27 20:11:21 UTC 2020 using Jira 7.13.12#713012-sha1:6e07c38070d5191bbf7353952ed38f111754533a.