Upd: Add endpoint for exchange authorisation code to obtain access token

Signed-off-by: George J Padayatti <[email protected]>
decentralised-dataexchange · Oct 19, 2023 · 9ce7da7 · 9ce7da7
1 parent e6657c3
commit 9ce7da7
Show file tree

Hide file tree

Showing 6 changed files with 94 additions and 0 deletions.
diff --git a/openapi/v2023.8.2/bundled.yaml b/openapi/v2023.8.2/bundled.yaml
@@ -2890,6 +2890,51 @@ paths:
       security: []
       tags:
         - onboard
+  /onboard/token/exchange:
+    post:
+      deprecated: false
+      description: Exchange authorisation code for access token
+      operationId: exchangeCodeForToken
+      parameters:
+        - description: Unique ID of an object
+          in: query
+          name: redirectUri
+          required: true
+          schema:
+            type: string
+        - description: Unique ID of an object
+          in: query
+          name: authorisationCode
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  userInfo:
+                    required:
+                      - subject
+                    type: object
+                    title: Token
+                    properties:
+                      subject:
+                        type: string
+                      profile:
+                        type: string
+                      email:
+                        type: string
+                      emailVerified:
+                        type: boolean
+                  token:
+                    $ref: '#/paths/~1onboard~1admin~1login/post/responses/200/content/application~1json/schema'
+          description: OK
+      security: []
+      tags:
+        - onboard
   /onboard/validate/email:
     post:
       operationId: validateEmail

diff --git a/openapi/v2023.8.2/definitions/UserInfo.yaml b/openapi/v2023.8.2/definitions/UserInfo.yaml
@@ -0,0 +1,13 @@
+required:
+  - subject
+type: object
+title: Token
+properties:
+  subject:
+    type: string
+  profile:
+    type: string
+  email:
+    type: string
+  emailVerified:
+    type: boolean
diff --git a/openapi/v2023.8.2/index.yaml b/openapi/v2023.8.2/index.yaml
@@ -213,6 +213,9 @@ paths:
   /onboard/token/refresh:
     post:
       $ref: ./paths/refreshToken.yaml
+  /onboard/token/exchange:
+    post:
+      $ref: ./paths/exchangeCodeForToken.yaml
   /onboard/validate/email:
     post:
       $ref: ./paths/validateEmail.yaml

diff --git a/openapi/v2023.8.2/parameters/authorisationCode.yaml b/openapi/v2023.8.2/parameters/authorisationCode.yaml
@@ -0,0 +1,6 @@
+description: Unique ID of an object
+in: query
+name: authorisationCode
+required: true
+schema:
+  type: string
diff --git a/openapi/v2023.8.2/parameters/redirectUri.yaml b/openapi/v2023.8.2/parameters/redirectUri.yaml
@@ -0,0 +1,6 @@
+description: Unique ID of an object
+in: query
+name: redirectUri
+required: true
+schema:
+  type: string
diff --git a/openapi/v2023.8.2/paths/exchangeCodeForToken.yaml b/openapi/v2023.8.2/paths/exchangeCodeForToken.yaml
@@ -0,0 +1,21 @@
+deprecated: false
+description: Exchange authorisation code for access token
+operationId: exchangeCodeForToken
+parameters:
+  - $ref: "../parameters/redirectUri.yaml"
+  - $ref: "../parameters/authorisationCode.yaml"
+responses:
+  "200":
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            userInfo:
+              $ref: "../definitions/UserInfo.yaml"
+            token:
+              $ref: "../definitions/Token.yaml"
+    description: OK
+security: []
+tags:
+  - onboard