feat(config-api): kc link plugin endpoint (#7794)

* feat(config-api): saml plugin changes for new fields Signed-off-by: pujavs <pujas.works@gmail.com> * feat(config-api): kc link plugin endpoint Signed-off-by: pujavs <pujas.works@gmail.com> * feat(config-api): kc link plugin endpoint Signed-off-by: pujavs <pujas.works@gmail.com> * feat(config-api): kc link plugin endpoint Signed-off-by: pujavs <pujas.works@gmail.com> * feat(config-api): saml plugin changes Signed-off-by: pujavs <pujas.works@gmail.com> * feat(config-api): kc plugin changes Signed-off-by: pujavs <pujas.works@gmail.com> --------- Signed-off-by: pujavs <pujas.works@gmail.com> Co-authored-by: YuriyZ <yzabrovarniy@gmail.com>
JanssenProject · Feb 21, 2024 · c9ce865 · c9ce865
1 parent f673e7f
commit c9ce865
Show file tree

Hide file tree

Showing 34 changed files with 1,476 additions and 52 deletions.
diff --git a/jans-config-api/docs/jans-config-api-swagger.yaml b/jans-config-api/docs/jans-config-api-swagger.yaml
@@ -7888,22 +7888,22 @@ components:
           $ref: '#/components/schemas/AttributeValidation'
         tooltip:
           type: string
-        selected:
-          type: boolean
         whitePagesCanView:
           type: boolean
+        selected:
+          type: boolean
         adminCanEdit:
           type: boolean
+        adminCanView:
+          type: boolean
         userCanView:
           type: boolean
         userCanEdit:
           type: boolean
-        adminCanView:
+        userCanAccess:
           type: boolean
         adminCanAccess:
           type: boolean
-        userCanAccess:
-          type: boolean
         baseDn:
           type: string
     PatchRequest:
@@ -8716,8 +8716,6 @@ components:
           type: boolean
         lockMessageConfig:
           $ref: '#/components/schemas/LockMessageConfig'
-        fapi:
-          type: boolean
         allResponseTypesSupported:
           uniqueItems: true
           type: array
@@ -8727,6 +8725,8 @@ components:
             - code
             - token
             - id_token
+        fapi:
+          type: boolean
     AuthenticationFilter:
       required:
       - baseDn

diff --git a/jans-config-api/plugins/docs/fido2-plugin-swagger.yaml b/jans-config-api/plugins/docs/fido2-plugin-swagger.yaml
@@ -269,7 +269,8 @@ components:
         challange:
           type: string
         challengeHash:
-          type: string
+          type: integer
+          format: int32
         creationDate:
           type: string
           format: date-time

diff --git a/jans-config-api/plugins/docs/kc-link-plugin-swagger.yaml b/jans-config-api/plugins/docs/kc-link-plugin-swagger.yaml
@@ -0,0 +1,274 @@
+openapi: 3.0.1
+info:
+  title: Jans Config API - Keycloak Link
+  contact:
+    name: Gluu Support
+    url: https://support.gluu.org
+    email: xxx@gluu.org
+  license:
+    name: Apache 2.0
+    url: https://github.com/JanssenProject/jans/blob/main/LICENSE
+  version: 1.0.0
+servers:
+- url: https://jans.io/
+  description: The Jans server
+tags:
+- name: Keycloak Link - Configuration
+paths:
+  /kc-link/kcLinkConfig:
+    get:
+      tags:
+      - KC Link - Configuration
+      summary: Gets KC Link configuration properties
+      description: Gets KC Link configuration properties
+      operationId: get-kc-link-properties
+      responses:
+        "200":
+          description: Ok
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AppConfiguration'
+        "401":
+          description: Unauthorized
+        "500":
+          description: InternalServerError
+      security:
+      - oauth2:
+        - https://jans.io/oauth/kc-link-config.readonly
+    put:
+      tags:
+      - KC Link - Configuration
+      summary: Update KC Link configuration properties
+      description: Update KC Link configuration properties
+      operationId: put-kc-link-properties
+      requestBody:
+        description: GluuAttribute object
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/AppConfiguration'
+            examples:
+              Request example:
+                description: Request example
+                value: ""
+      responses:
+        "200":
+          description: Ok
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AppConfiguration'
+        "401":
+          description: Unauthorized
+        "500":
+          description: InternalServerError
+      security:
+      - oauth2:
+        - https://jans.io/oauth/kc-link-config.write
+    patch:
+      tags:
+      - KC Link - Configuration
+      summary: Partially modifies KC Link configuration properties.
+      description: Partially modifies KC Link configuration properties.
+      operationId: patch-kc-link-properties
+      requestBody:
+        description: String representing patch-document.
+        content:
+          application/json-patch+json:
+            schema:
+              type: array
+              items:
+                $ref: '#/components/schemas/JsonPatch'
+            examples:
+              Request json example:
+                description: Request json example
+                value: ""
+      responses:
+        "200":
+          description: Ok
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AppConfiguration'
+        "401":
+          description: Unauthorized
+        "500":
+          description: InternalServerError
+      security:
+      - oauth2:
+        - https://jans.io/oauth/kc-link-config.write
+components:
+  schemas:
+    AppConfiguration:
+      type: object
+      properties:
+        sourceConfigs:
+          type: array
+          items:
+            $ref: '#/components/schemas/GluuLdapConfiguration'
+        inumConfig:
+          $ref: '#/components/schemas/GluuLdapConfiguration'
+        targetConfig:
+          $ref: '#/components/schemas/GluuLdapConfiguration'
+        ldapSearchSizeLimit:
+          type: integer
+          format: int32
+        keyAttributes:
+          type: array
+          items:
+            type: string
+        keyObjectClasses:
+          type: array
+          items:
+            type: string
+        sourceAttributes:
+          type: array
+          items:
+            type: string
+        customLdapFilter:
+          type: string
+        updateMethod:
+          type: string
+        defaultInumServer:
+          type: boolean
+        keepExternalPerson:
+          type: boolean
+        useSearchLimit:
+          type: boolean
+        attributeMapping:
+          type: array
+          items:
+            $ref: '#/components/schemas/CacheRefreshAttributeMapping'
+        snapshotFolder:
+          type: string
+        snapshotMaxCount:
+          type: integer
+          format: int32
+        keycloakConfiguration:
+          $ref: '#/components/schemas/KeycloakConfiguration'
+        baseDN:
+          type: string
+        personObjectClassTypes:
+          type: array
+          items:
+            type: string
+        personCustomObjectClass:
+          type: string
+        contactObjectClassTypes:
+          type: array
+          items:
+            type: string
+        allowPersonModification:
+          type: boolean
+        supportedUserStatus:
+          type: array
+          items:
+            type: string
+        loggingLevel:
+          type: string
+        loggingLayout:
+          type: string
+        externalLoggerConfiguration:
+          type: string
+        metricReporterInterval:
+          type: integer
+          format: int32
+        metricReporterKeepDataDays:
+          type: integer
+          format: int32
+        metricReporterEnabled:
+          type: boolean
+        disableJdkLogger:
+          type: boolean
+        cleanServiceInterval:
+          type: integer
+          format: int32
+        keycloakLinkEnabled:
+          type: boolean
+        keycloakLinkServerIpAddress:
+          type: string
+        keycloakLinkPollingInterval:
+          type: string
+        keycloakLinkLastUpdate:
+          type: string
+          format: date-time
+        keycloakLinkLastUpdateCount:
+          type: string
+        keycloakLinkProblemCount:
+          type: string
+        useLocalCache:
+          type: boolean
+    CacheRefreshAttributeMapping:
+      type: object
+      properties:
+        source:
+          type: string
+        destination:
+          type: string
+    GluuLdapConfiguration:
+      type: object
+      properties:
+        configId:
+          type: string
+        bindDN:
+          type: string
+        bindPassword:
+          type: string
+        servers:
+          type: array
+          items:
+            type: string
+        maxConnections:
+          type: integer
+          format: int32
+        useSSL:
+          type: boolean
+        baseDNs:
+          type: array
+          items:
+            type: string
+        primaryKey:
+          type: string
+        localPrimaryKey:
+          type: string
+        useAnonymousBind:
+          type: boolean
+        enabled:
+          type: boolean
+        version:
+          type: integer
+          format: int32
+        level:
+          type: integer
+          format: int32
+    KeycloakConfiguration:
+      type: object
+      properties:
+        serverUrl:
+          type: string
+        realm:
+          type: string
+        clientId:
+          type: string
+        clientSecret:
+          type: string
+        grantType:
+          type: string
+        username:
+          type: string
+        password:
+          type: string
+    JsonPatch:
+      type: object
+  securitySchemes:
+    oauth2:
+      type: oauth2
+      flows:
+        clientCredentials:
+          tokenUrl: "https://{op-hostname}/.../token"
+          scopes:
+            https://jans.io/oauth/kc-link-config.readonly: View Keycloak Link configuration
+              related information
+            https://jans.io/oauth/kc-link-config.write: Manage Keycloak Link configuration
+              related information
diff --git a/jans-config-api/plugins/docs/kc-saml-plugin-swagger.yaml b/jans-config-api/plugins/docs/kc-saml-plugin-swagger.yaml
@@ -1009,6 +1009,7 @@ components:
           type: string
     TrustRelationship:
       required:
+      - clientId
       - description
       - displayName
       - spMetaDataSourceType
@@ -1021,6 +1022,8 @@ components:
         owner:
           type: string
         clientId:
+          maxLength: 60
+          minLength: 0
           type: string
         displayName:
           maxLength: 60
@@ -1058,14 +1061,20 @@ components:
           - federation
           - manual
           - mdq
-        spMetaDataURL:
+        nameIDPolicyFormat:
           type: string
-        metaLocation:
+        entityId:
           type: string
-        jansEntityId:
+        singleLogoutServiceUrl:
+          type: string
+        redirectUris:
           type: array
           items:
             type: string
+        spMetaDataURL:
+          type: string
+        metaLocation:
+          type: string
         releasedAttributes:
           type: array
           items: