JSON Schema Update

Author: Github Workflow

config/v3/get_third_party_redirect/example.json

@@ -0,0 +1,4 @@
+{
+    "get_third_party_redirect": 1,
+    "name": "dynamicworks"
+}

config/v3/get_third_party_redirect/receive.json

@@ -0,0 +1,31 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "Third Party Redirect Login SSO URL (response)",
+    "description": "The result for Third Party Redirect URL for sso login.",
+    "type": "object",
+    "required": [
+        "echo_req",
+        "msg_type"
+    ],
+    "properties": {
+        "redirect_url": {
+            "description": "Redirect URL for sso login.",
+            "type": "string"
+        },
+        "echo_req": {
+            "description": "Echo of the request made.",
+            "type": "object"
+        },
+        "msg_type": {
+            "description": "Action name of the request made.",
+            "type": "string",
+            "enum": [
+                "get_third_party_redirect"
+            ]
+        },
+        "req_id": {
+            "description": "Optional field sent in request to map to response, present only when request contains `req_id`.",
+            "type": "integer"
+        }
+    }
+}

config/v3/get_third_party_redirect/send.json

@@ -0,0 +1,44 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "Third Party Redirect Login SSO URL (request)",
+    "description": "Get Third Party Redirect URL for sso login.",
+    "type": "object",
+    "auth_required": 1,
+    "auth_scopes": [
+        "read"
+    ],
+    "additionalProperties": false,
+    "required": [
+        "get_third_party_redirect",
+        "name"
+    ],
+    "properties": {
+        "get_third_party_redirect": {
+            "description": "Must be `1`",
+            "type": "integer",
+            "enum": [
+                1
+            ]
+        },
+        "name": {
+            "description": "The name of third party platform for redirect URL.",
+            "type": "string",
+            "enum": [
+                "dynamicworks"
+            ]
+        },
+        "loginid": {
+            "description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
+            "type": "string",
+            "pattern": "^[A-Za-z]+[0-9]+$"
+        },
+        "passthrough": {
+            "description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field.",
+            "type": "object"
+        },
+        "req_id": {
+            "description": "[Optional] Used to map request to response.",
+            "type": "integer"
+        }
+    }
+}

static/data/v3.yml

@@ -77,6 +77,8 @@ groups:
         title: Get Self-Exclusion
       - name: get_settings
         title: Get Account Settings
+      - name: get_third_party_redirect
+        title: Third Party Redirect Login SSO URL
       - name: identity_verification_document_add
         title: Identity Verification Add Document
       - name: kyc_auth_status