[OPENAM-12229] REST API resource version for WebAgent or other agents type is always 1.0 between versions. Created: 18/Dec/17  Updated: 25/May/18

Status: Open
Project: OpenAM
Component/s: API descriptor, rest
Affects Version/s: 14.0.0, 14.1.0, 14.1.1, 5.5.1
Fix Version/s: None

Type: Bug Priority: Major
Reporter: C-Weng C Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: AME, Backlog
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
relates to OPENAM-12235 REST API for agent creation on Update... Open
Target Version/s:
Rank: 1|hzuyk7:
Support Ticket IDs:


Bug description

By checking the API for 14.1.1, 5.5.1 and 6.0.0 (from /openam/json/?_api), it seems that there is changes in the input/output models for the WebAgent and possibly other (realm-config/agents)

For example 5.1.1 the WebAgent schema does not have "inherited" and values defined inside a nested Json block

          "agentDebugLevel": {
            "type": "string",
            "description": "Agent debug level. (property name: com.sun.identity.agents.config.debug.level) <br>Hot-swap: Yes",
            "title": "Agent Debug Level",
            "x-propertyOrder": 21900
  • It seems the 5.1.1 does have agentGroup
               "agentDebugLevel": {
                  "type": "object",
                  "properties": {
                    "inherited": {
                      "type": "boolean"
                    "value": {
                      "type": "string"
                  "title": "Agent Debug Level",

Similarly there is changes in 6.0.0 where new items are created (due to inheritance and hence the inherited. But 5.5.x is not yet ready for this (other than the OAuth2 with does have agentGroup for the inheritance). 5.5.x schema seems it does not show.

The main issues is they all have resource version 1.0 (in the API descriptor)

How to reproduce the issue

Details steps outlining how to recreate the issue (remove this text)

  1. Just install the respective AM
  2. Goto API Explorer and check the resource version
  3. Get the /openam/json/?_api to get the API descriptor and compare some of the WebAgent and other schema.
  4. ...
Expected behaviour
Different schema should be versioned corrected (or if this is unstable) should probably be labelled as such (to avoid use)
Current behaviour
The API version looks the same but then it does not seems these are all the same behaving.

Work around


Generated at Tue Mar 09 09:50:39 UTC 2021 using Jira 7.13.12#713012-sha1:6e07c38070d5191bbf7353952ed38f111754533a.