fix(config-api): user custom attribute changes and agama param changes (

#4123) * fix(config-api): customObjectClass changes * fix(config-api): user custom attribute changes and agama param changes * fix(config-api): user custom attribute changes and agama param changes * fix(config-api): user custom attribute changes and agama param changes
JanssenProject · Mar 10, 2023 · 291004e · 291004e
1 parent 635f611
commit 291004e
Show file tree

Hide file tree

Showing 10 changed files with 240 additions and 76 deletions.
diff --git a/jans-config-api/common/src/main/java/io/jans/configapi/util/ApiConstants.java b/jans-config-api/common/src/main/java/io/jans/configapi/util/ApiConstants.java
@@ -12,6 +12,7 @@ private ApiConstants() {}
 
     public static final String BASE_API_URL = "/";
     public static final String CONFIG = "/config";
+    public static final String CONFIGS = "/configs";
     public static final String API_CONFIG = "/api-config";
     public static final String JWKS = "/jwks";
     public static final String JANS_AUTH = "/jans-auth-server";
@@ -113,6 +114,7 @@ private ApiConstants() {}
     public static final String ACTIVE = "active";
     public static final String INACTIVE = "inactive"; 
     public static final String ADD_SCRIPT_TEMPLATE = "addScriptTemplate";
+    public static final String REMOVE_NON_LDAP_ATTRIBUTES = "removeNonLDAPAttributes";    
 
     // API Protection
     public static final String PROTECTION_TYPE_OAUTH2 = "oauth2";

diff --git a/jans-config-api/docs/jans-config-api-swagger.yaml b/jans-config-api/docs/jans-config-api-swagger.yaml
@@ -209,8 +209,6 @@ paths:
       security:
       - oauth2:
         - https://jans.io/oauth/config/agama.readonly
-        - https://jans.io/oauth/config/agama.write
-        - https://jans.io/oauth/config/read-all
     post:
       tags:
       - Agama - Developer Studio
@@ -252,7 +250,6 @@ paths:
       security:
       - oauth2:
         - https://jans.io/oauth/config/agama.write
-        - https://jans.io/oauth/config/write-all
     delete:
       tags:
       - Agama - Developer Studio
@@ -282,19 +279,40 @@ paths:
         - https://jans.io/oauth/config/agama.delete
   /api/v1/agama-deployment/configs:
     get:
-      operationId: getConfigs
+      tags:
+      - Agama - Developer Studio
+      summary: Retrieve the list of configs based on name.
+      description: Retrieve the list of configs based on name.
+      operationId: get-agama-dev-prj-configs
       parameters:
       - name: name
         in: query
         schema:
           type: string
       responses:
-        default:
-          description: default response
+        "200":
+          description: Agama projects configs
           content:
-            application/json: {}
+            application/json:
+              schema:
+                type: string
+              examples:
+                Response json example:
+                  description: Response json example
+                  value: ""
+        "401":
+          description: Unauthorized
+        "500":
+          description: InternalServerError
+      security:
+      - oauth2:
+        - https://jans.io/oauth/config/agama.readonly
     put:
-      operationId: setConfigs
+      tags:
+      - Agama - Developer Studio
+      summary: Update an Agama project.
+      description: Update an Agama project.
+      operationId: put-agama-dev-studio-prj
       parameters:
       - name: name
         in: query
@@ -310,10 +328,27 @@ paths:
                 additionalProperties:
                   type: object
       responses:
-        default:
-          description: default response
+        "202":
+          description: Agama project accepted
           content:
-            application/json: {}
+            application/json:
+              schema:
+                type: string
+              examples:
+                Response json example:
+                  description: Response json example
+                  value: ""
+        "400":
+          description: Bad Request
+        "401":
+          description: Unauthorized
+        "409":
+          description: Conflict
+        "500":
+          description: InternalServerError
+      security:
+      - oauth2:
+        - https://jans.io/oauth/config/agama.write
   /api/v1/agama-deployment/list:
     get:
       tags:
@@ -350,8 +385,6 @@ paths:
       security:
       - oauth2:
         - https://jans.io/oauth/config/agama.readonly
-        - https://jans.io/oauth/config/agama.write
-        - https://jans.io/oauth/config/read-all
   /api/v1/agama:
     get:
       tags:
@@ -7573,20 +7606,20 @@ components:
           $ref: '#/components/schemas/AttributeValidation'
         tooltip:
           type: string
-        adminCanAccess:
+        whitePagesCanView:
           type: boolean
         adminCanView:
           type: boolean
-        adminCanEdit:
-          type: boolean
         userCanAccess:
           type: boolean
         userCanView:
           type: boolean
-        whitePagesCanView:
-          type: boolean
         userCanEdit:
           type: boolean
+        adminCanAccess:
+          type: boolean
+        adminCanEdit:
+          type: boolean
         baseDn:
           type: string
     PatchRequest:
@@ -8975,10 +9008,10 @@ components:
           type: array
           items:
             type: object
-        displayValue:
-          type: string
         value:
           type: object
+        displayValue:
+          type: string
     LocalizedString:
       type: object
       properties:

diff --git a/jans-config-api/plugins/docs/user-mgt-plugin-swagger.yaml b/jans-config-api/plugins/docs/user-mgt-plugin-swagger.yaml
@@ -121,6 +121,15 @@ paths:
       summary: Update User
       description: Update User
       operationId: put-user
+      parameters:
+      - name: removeNonLDAPAttributes
+        in: query
+        description: "Boolean flag to indicate if attributes to be removed for non-LDAP\
+          \ DB. Default value is true, indicating non-LDAP attributes will be removed\
+          \ from request."
+        schema:
+          type: boolean
+          default: true
       requestBody:
         description: User object
         content:
@@ -302,6 +311,8 @@ paths:
                         "givenName": "Test3",
                         "baseDn": "inum=559a7e26-7a33-4e11-9d42-13266d33261e,ou=people,o=jans"
                     }
+        "400":
+          description: Bad Request
         "401":
           description: Unauthorized
         "404":
@@ -317,6 +328,15 @@ paths:
       summary: Create new User
       description: Create new User
       operationId: post-user
+      parameters:
+      - name: removeNonLDAPAttributes
+        in: query
+        description: "Boolean flag to indicate if attributes to be removed for non-LDAP\
+          \ DB. Default value is true, indicating non-LDAP attributes will be removed\
+          \ from request."
+        schema:
+          type: boolean
+          default: true
       requestBody:
         description: User object
         content:
@@ -495,6 +515,8 @@ paths:
                         "givenName": "Test3",
                         "baseDn": "inum=559a7e26-7a33-4e11-9d42-13266d33261e,ou=people,o=jans"
                     }
+        "400":
+          description: Bad Request
         "401":
           description: Unauthorized
         "500":
@@ -654,6 +676,14 @@ paths:
         required: true
         schema:
           type: string
+      - name: removeNonLDAPAttributes
+        in: query
+        description: "Boolean flag to indicate if attributes to be removed for non-LDAP\
+          \ DB. Default value is true, indicating non-LDAP attributes will be removed\
+          \ from request."
+        schema:
+          type: boolean
+          default: true
       requestBody:
         description: UserPatchRequest
         content:
@@ -772,6 +802,8 @@ paths:
                         "givenName": "Test3",
                         "baseDn": "inum=559a7e26-7a33-4e11-9d42-13266d33261e,ou=people,o=jans"
                     }
+        "400":
+          description: Bad Request
         "401":
           description: Unauthorized
         "404":
@@ -794,10 +826,10 @@ components:
           type: array
           items:
             type: object
-        displayValue:
-          type: string
         value:
           type: object
+        displayValue:
+          type: string
     CustomUser:
       type: object
       properties: