Update experimental external principals API with auth service (#7566)

api/authorization.yml

@@ -1102,7 +1102,7 @@ paths:
           $ref: "#/components/responses/Unauthorized"
         default:
           $ref: "#/components/responses/ServerError"
-  /auth/users/{userId}/external/principals:
+  /auth/users/{userId}/external/principals/ls:
       parameters:
         - in: path
           name: userId
@@ -1133,14 +1133,14 @@ paths:
           default:
             $ref: "#/components/responses/ServerError"
 
-  /auth/users/{userId}/external/principals/{principalId}:
+  /auth/users/{userId}/external/principals:
     parameters:
       - in: path
         name: userId
         required: true
         schema:
           type: string
-      - in: path
+      - in: query
         name: principalId
         required: true
         schema:
@@ -1177,12 +1177,21 @@ paths:
               $ref: "#/components/responses/NotFound"
             default:
               $ref: "#/components/responses/ServerError"
+
+  /auth/external/principals:
+    parameters:
+      - in: query
+        name: principalId
+        required: true
+        schema:
+          type: string
     get:
       tags:
         - auth
+        - external
         - experimental
-      operationId: getUserExternalPrincipal
-      summary: get external principal
+      operationId: getExternalPrincipal
+      summary: describe external principal by id 
       responses:
         200:
           description: external principal
@@ -1194,9 +1203,11 @@ paths:
           $ref: "#/components/responses/Unauthorized"
         404:
           $ref: "#/components/responses/NotFound"
+        420:
+          description: too many requests
         default:
-          $ref: "#/components/responses/ServerError"
-          
+          $ref: "#/components/responses/ServerError"          
+
   /healthcheck:
     get:
       operationId: healthCheck

api/swagger.yml

@@ -2434,14 +2434,15 @@ paths:
         default:
           $ref: "#/components/responses/ServerError"
 
-  /auth/users/{userId}/external/principal/{principalId}:
+
+  /auth/users/{userId}/external/principals:
     parameters:
       - in: path
         name: userId
         required: true
         schema:
           type: string
-      - in: path
+      - in: query
         name: principalId
         required: true
         schema:
@@ -2454,7 +2455,7 @@ paths:
       operationId: createUserExternalPrincipal
       summary: attach external principal to user
       requestBody: 
-        required: true
+        required: false
         content: 
           application/json: 
             schema: 
@@ -2490,20 +2491,32 @@ paths:
           description: too many requests
         default:
           $ref: "#/components/responses/ServerError"
+
+  /auth/users/{userId}/external/principals/ls:
+    parameters:
+      - in: path
+        name: userId
+        required: true
+        schema:
+          type: string
     get:
       tags:
         - auth
         - external
         - experimental
-      operationId: getUserExternalPrincipal
-      summary: get external principal of a user
+      parameters:
+        - $ref: "#/components/parameters/PaginationPrefix"
+        - $ref: "#/components/parameters/PaginationAfter"
+        - $ref: "#/components/parameters/PaginationAmount"
+      operationId: listUserExternalPrincipals
+      summary: list user external policies attached to a user
       responses:
         200:
-          description: external principal
+          description: external principals list
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/ExternalPrincipal"
+                $ref: "#/components/schemas/ExternalPrincipalList"
         401:
           $ref: "#/components/responses/Unauthorized"
         404:
@@ -2513,10 +2526,10 @@ paths:
         default:
           $ref: "#/components/responses/ServerError"
 
-  /auth/users/{userId}/external/principals:
+  /auth/external/principals:
     parameters:
-      - in: path
-        name: userId
+      - in: query
+        name: principalId
         required: true
         schema:
           type: string
@@ -2525,19 +2538,15 @@ paths:
         - auth
         - external
         - experimental
-      parameters:
-        - $ref: "#/components/parameters/PaginationPrefix"
-        - $ref: "#/components/parameters/PaginationAfter"
-        - $ref: "#/components/parameters/PaginationAmount"
-      operationId: listUserExternalPrincipals
-      summary: list user external policies attached to a user
+      operationId: getExternalPrincipal
+      summary: describe external principal by id 
       responses:
         200:
-          description: external principals list
+          description: external principal
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/ExternalPrincipalList"
+                $ref: "#/components/schemas/ExternalPrincipal"
         401:
           $ref: "#/components/responses/Unauthorized"
         404:
@@ -2546,6 +2555,7 @@ paths:
           description: too many requests
         default:
           $ref: "#/components/responses/ServerError"
+
   /auth/groups/{groupId}/policies:
     parameters:
       - in: path