Version 2

sonuramts · sonuramts · commit 2328fa2f18a3 · 2025-11-20T18:55:29.000+05:30
diff --git a/api-spec/openapiSpecv3-2_0.json b/api-spec/openapiSpecv3-2_0.json
@@ -2844,8 +2844,8 @@
     },
     "/api/rest/2.0/connections/refresh-tokens/revoke": {
       "post": {
-        "operationId": "invalidateConnectionTokens",
-        "description": "\n <span class=\"since-beta-tag\">Version: 26.2.0.cl or later</span>\n\nUser should have Administrative Privilege or be the Connection Author to Invalidates the refresh tokens.\n\n## Token Invalidation Rules\n\nYou can specify different combinations of identifiers to control\nwhich refresh tokens are invalidated:\n\n- **connection_identifier only**: All user's refresh tokens will be\n  deleted except the connection author.\n- **connection_identifier + user_identifiers**: Only specified user's\n  refresh tokens will be deleted. If the author's user_identifier is\n  included, their token will also be invalidated.\n- **connection_identifier + configuration_identifiers**: Refresh\n  tokens for the specified configurations will be deleted.\n- **connection_identifier + org_identifiers**: Refresh tokens for the\n  specified orgs will be deleted. This is only applicable for published\n  connections.\n\n**Note**: The `org_identifiers` field is only applicable for published connections. Using this field with unpublished connections will result in an error: \"The 'org_identifiers' field is only applicable for published connections. Please ensure the connection is published before including this field.\"\n\nAfter tokens are invalidated, logged-in users will need to re-authenticate to access visualizations.\n\n\n\n\n#### Endpoint URL\n",
+        "operationId": "revokeRefreshTokens",
+        "description": "\n <span class=\"since-beta-tag\">Version: 26.2.0.cl or later</span>\n\nRevokes OAuth refresh tokens for users who no longer require access to a data warehouse connection.\nWhen a token is revoked, the affected user's session for that connection is terminated, and they must re-authenticate to regain access.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DATAMANAGEMENT` (**Can manage data**) privileges.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on the ThoughtSpot instance, users with `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege can also make API requests to revoke tokens for connection users.\n\n#### Usage guidelines\n\nYou can specify different combinations of identifiers to control which refresh tokens are revoked.\n\n- **connection_identifier**: Revokes refresh tokens for all users of the connection, except the connection author.\n- **connection_identifier** and **user_identifiers**: Revokes refresh tokens only for the users specified in the request. If the name or ID of the connection author is included in the request, their token will also be revoked.\n- **connection_identifier** and **configuration_identifiers**: Revokes refresh tokens for the specified configurations.\n- **connection_identifier**, **configuration_identifiers**, and **user_identifiers**: Revokes refresh tokens for the specified users on the specified configurations.\n- **connection_identifier** and **org_identifiers**: Revokes refresh tokens for the specified Orgs. Applicable only for published connections.\n- **connection_identifier**, **org_identifiers**, and **user_identifiers**: Revokes refresh tokens for the specified users in the specified Orgs. Applicable only for published connections.\n\n**NOTE**: The `org_identifiers` parameter is only applicable for published connections. Using this parameter for unpublished connections will result in an error. Ensure that the connections are published before making the API request.\n\n\n\n\n#### Endpoint URL\n",
         "tags": [
           "Connections",
           "26.2.0.cl"
@@ -2857,25 +2857,25 @@
                 "type": "object",
                 "properties": {
                   "connection_identifier": {
-                    "description": "Unique ID or name of the connection whose token needs to be deleted. All the users associated with the connection will have their tokens deleted except the author.",
+                    "description": "Unique ID or name of the connection whose refresh tokens need to be revoked. All the users associated with the connection will have their refresh tokens revoked except the author.",
                     "type": "string"
                   },
                   "configuration_identifiers": {
-                    "description": "Unique ID or name of configurations. If provided, the specified configuration's user tokens will be deleted.",
+                    "description": "Unique ID or name of the configuration. When provided, the refresh tokens of the users associated with the connection configuration will be revoked.",
                     "type": "array",
                     "items": {
                       "type": "string"
                     }
                   },
                   "user_identifiers": {
-                    "description": "Unique ID or name of users. If provided, only the specified user's refresh tokens will be deleted. If the author's user_identifier is included, their token will also be deleted.",
+                    "description": "Unique ID or name of the users. When provided, the refresh tokens of the specified users will be revoked. If the request includes the user ID or name of the connection author, their token will also be revoked.",
                     "type": "array",
                     "items": {
                       "type": "string"
                     }
                   },
                   "org_identifiers": {
-                    "description": "Unique ID or name of orgs. This is applicable only for published connections. If provided, the specified org's user tokens will be deleted. This field is only valid for published connections; using it with unpublished connections will return an error.",
+                    "description": "Unique ID or name of the Org. When provided, the refresh tokens of all users associated with the published connection in the Org will be revoked. This parameter is valid only for published connections. Using it with unpublished connections will result in an error.",
                     "type": "array",
                     "items": {
                       "type": "string"
@@ -2897,7 +2897,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/InvalidateConnectionTokensResponse"
+                  "$ref": "#/components/schemas/RevokeRefreshTokensResponse"
                 }
               }
             }
@@ -14545,7 +14545,7 @@
     "/api/rest/2.0/template/variables/create": {
       "post": {
         "operationId": "createVariable",
-        "description": "\nCreate a variable which can be used for parameterizing metadata objects <br/> <span class=\"since-beta-tag\">Beta</span> <span class=\"since-beta-tag\">Version: 10.14.0.cl or later</span>\n\nAllows creating a variable which can be used for parameterizing metadata objects in ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint supports the following types of variables:\n* CONNECTION_PROPERTY - For connection properties\n* TABLE_MAPPING - For table mappings\n* CONNECTION_PROPERTY_PER_PRINCIPAL - For connection properties per principal. In order to use this please contact support to enable this.\n* FORMULA_VARIABLE - For Formula variables\n\nWhen creating a variable, you need to specify:\n* The variable type\n* A unique name for the variable\n* Whether the variable contains sensitive values (defaults to false)\n* The data type of the variable, only specify for fomula variables (defaults to null)\n\nThe operation will fail if:\n* The user lacks required permissions\n* The variable name already exists\n* The variable type is invalid\n\n\n\n#### Endpoint URL\n",
+        "description": "\nCreate a variable which can be used for parameterizing metadata objects <br/> <span class=\"since-beta-tag\">Beta</span> <span class=\"since-beta-tag\">Version: 10.14.0.cl or later</span>\n\nAllows creating a variable which can be used for parameterizing metadata objects in ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint supports the following types of variables:\n* CONNECTION_PROPERTY - For connection properties\n* TABLE_MAPPING - For table mappings\n* CONNECTION_PROPERTY_PER_PRINCIPAL - For connection properties per principal. In order to use this please contact support to enable this.\n* FORMULA_VARIABLE - For Formula variables, introduced in 10.15.0.cl\n\nWhen creating a variable, you need to specify:\n* The variable type\n* A unique name for the variable\n* Whether the variable contains sensitive values (defaults to false)\n* The data type of the variable, only specify for formula variables (defaults to null)\n\nThe operation will fail if:\n* The user lacks required permissions\n* The variable name already exists\n* The variable type is invalid\n\n\n\n#### Endpoint URL\n",
         "tags": [
           "Variable",
           "10.14.0.cl"
@@ -14577,7 +14577,7 @@
                     "nullable": true
                   },
                   "data_type": {
-                    "description": "Variable Data Type",
+                    "description": "Variable Data Type, only for formula_variable type, leave empty for others <br/>  <span class=\"since-beta-tag\">Version: 10.15.0.cl or later</span>",
                     "type": "string",
                     "enum": [
                       "VARCHAR",
@@ -22380,15 +22380,15 @@
           }
         }
       },
-      "InvalidateConnectionTokensResponse": {
+      "RevokeRefreshTokensResponse": {
         "type": "object",
         "required": [
-          "revoke_result"
+          "data"
         ],
         "properties": {
-          "revoke_result": {
+          "data": {
             "type": "string",
-            "description": "Result message describing the outcome of the token revocation operation."
+            "description": "Result message describing the outcome of the refresh token revocation operation."
           }
         }
       },
