feat: support service accounts

Add extended information to provide when an endpoint could be used for a service account too. Signed-off-by: Alejandro Visiedo <avisiedo@redhat.com>
avisiedo · Jun 12, 2024 · 95d9bbf · 95d9bbf
1 parent a654f55
commit 95d9bbf
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 7 deletions.
diff --git a/public.openapi.json b/public.openapi.json
@@ -83,7 +83,8 @@
         "security": [
           {
             "x-rh-identity": [
-              "Type:User"
+              "Type:User",
+              "Type:ServiceAccount"
             ]
           }
         ],
@@ -177,7 +178,8 @@
         "security": [
           {
             "x-rh-identity": [
-              "Type:User"
+              "Type:User",
+              "Type:ServiceAccount"
             ]
           }
         ],
@@ -215,7 +217,8 @@
         "security": [
           {
             "x-rh-identity": [
-              "Type:User"
+              "Type:User",
+              "Type:ServiceAccount"
             ]
           }
         ],
@@ -241,7 +244,8 @@
         "security": [
           {
             "x-rh-identity": [
-              "Type:User"
+              "Type:User",
+              "Type:ServiceAccount"
             ]
           }
         ],
@@ -281,7 +285,8 @@
         "security": [
           {
             "x-rh-identity": [
-              "Type:User"
+              "Type:User",
+              "Type:ServiceAccount"
             ]
           }
         ],
@@ -428,7 +433,8 @@
           {
             "x-rh-identity": [
               "Type:System",
-              "Type:User"
+              "Type:User",
+              "Type:ServiceAccount"
             ]
           }
         ],
@@ -1547,7 +1553,7 @@
     "securitySchemes": {
       "x-rh-identity": {
         "name": "X-Rh-Identity",
-        "description": "Base64-encoded JSON identity header provided by 3Scale API gateway.\nThe JSON object contains type (System, User), org_id, and either username or certificate CN.\nScopes:\n- 'Type:User' for user access\n- 'Type:System': for system access (hosts with RHSM mTLS auth)\n- 'Type:System:domain' for system access, limited to host's domain\n",
+        "description": "Base64-encoded JSON identity header provided by 3Scale API gateway.\nThe JSON object contains type (System, User), org_id, and either username or certificate CN.\nScopes:\n- 'Type:User' for user access\n- 'Type:ServiceAccount' for service accounts\n- 'Type:System': for system access (hosts with RHSM mTLS auth)\n- 'Type:System:domain' for system access, limited to host's domain\n",
         "type": "apiKey",
         "in": "header"
       },

diff --git a/public.openapi.yaml b/public.openapi.yaml
@@ -57,6 +57,7 @@ paths:
             security:
                 - x-rh-identity:
                       - Type:User
+                      - Type:ServiceAccount
             tags:
                 - resources
         post:
@@ -112,6 +113,7 @@ paths:
             security:
                 - x-rh-identity:
                       - Type:User
+                      - Type:ServiceAccount
             tags:
                 - resources
     /domains/{uuid}:
@@ -134,6 +136,7 @@ paths:
             security:
                 - x-rh-identity:
                       - Type:User
+                      - Type:ServiceAccount
             tags:
                 - resources
         get:
@@ -150,6 +153,7 @@ paths:
             security:
                 - x-rh-identity:
                       - Type:User
+                      - Type:ServiceAccount
             tags:
                 - resources
         patch:
@@ -175,6 +179,7 @@ paths:
             security:
                 - x-rh-identity:
                       - Type:User
+                      - Type:ServiceAccount
             tags:
                 - resources
         put:
@@ -266,6 +271,7 @@ paths:
                 - x-rh-identity:
                       - Type:System
                       - Type:User
+                      - Type:ServiceAccount
             tags:
                 - resources
 components:
@@ -1123,6 +1129,7 @@ components:
                 The JSON object contains type (System, User), org_id, and either username or certificate CN.
                 Scopes:
                 - 'Type:User' for user access
+                - 'Type:ServiceAccount' for service accounts
                 - 'Type:System': for system access (hosts with RHSM mTLS auth)
                 - 'Type:System:domain' for system access, limited to host's domain
             type: apiKey