Skip to content

Commit 7dd85cf

Browse files
sonuramtssonuramts
committed
Version 2
1 parent 0e31bf4 commit 7dd85cf

File tree

1 file changed

+59
-25
lines changed

1 file changed

+59
-25
lines changed

‎api-spec/openapiSpecv3-2_0.json‎

Lines changed: 59 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2842,10 +2842,10 @@
28422842
}
28432843
}
28442844
},
2845-
"/api/rest/2.0/connections/refresh-tokens/revoke": {
2845+
"/api/rest/2.0/connections/revoke-refresh-tokens/{connection_identifier}": {
28462846
"post": {
2847-
"operationId": "invalidateConnectionTokens",
2848-
"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",
2847+
"operationId": "revokeRefreshTokens",
2848+
"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 all users on the specified configurations, except the configuration author.\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",
28492849
"tags": [
28502850
"Connections",
28512851
"26.2.0.cl"
@@ -2856,48 +2856,51 @@
28562856
"schema": {
28572857
"type": "object",
28582858
"properties": {
2859-
"connection_identifier": {
2860-
"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.",
2861-
"type": "string"
2862-
},
28632859
"configuration_identifiers": {
2864-
"description": "Unique ID or name of configurations. If provided, the specified configuration's user tokens will be deleted.",
2860+
"description": "Unique ID or name of the configuration. When provided, the refresh tokens of the users associated with the connection configuration will be revoked.",
28652861
"type": "array",
28662862
"items": {
28672863
"type": "string"
28682864
}
28692865
},
28702866
"user_identifiers": {
2871-
"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.",
2867+
"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.",
28722868
"type": "array",
28732869
"items": {
28742870
"type": "string"
28752871
}
28762872
},
28772873
"org_identifiers": {
2878-
"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.",
2874+
"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.",
28792875
"type": "array",
28802876
"items": {
28812877
"type": "string"
28822878
}
28832879
}
2884-
},
2885-
"required": [
2886-
"connection_identifier"
2887-
]
2880+
}
28882881
}
28892882
}
28902883
},
28912884
"required": true
28922885
},
2893-
"parameters": [],
2886+
"parameters": [
2887+
{
2888+
"in": "path",
2889+
"name": "connection_identifier",
2890+
"required": true,
2891+
"schema": {
2892+
"type": "string"
2893+
},
2894+
"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."
2895+
}
2896+
],
28942897
"responses": {
28952898
"200": {
28962899
"description": "Token(s) successfully revoked.",
28972900
"content": {
28982901
"application/json": {
28992902
"schema": {
2900-
"$ref": "#/components/schemas/InvalidateConnectionTokensResponse"
2903+
"$ref": "#/components/schemas/RevokeRefreshTokensResponse"
29012904
}
29022905
}
29032906
}
@@ -2932,6 +2935,26 @@
29322935
}
29332936
}
29342937
},
2938+
"404": {
2939+
"description": "Object not found",
2940+
"content": {
2941+
"application/json": {
2942+
"schema": {
2943+
"$ref": "#/components/schemas/ErrorResponse"
2944+
}
2945+
}
2946+
}
2947+
},
2948+
"409": {
2949+
"description": "Conflict",
2950+
"content": {
2951+
"application/json": {
2952+
"schema": {
2953+
"$ref": "#/components/schemas/ErrorResponse"
2954+
}
2955+
}
2956+
}
2957+
},
29352958
"500": {
29362959
"description": "Unexpected error",
29372960
"content": {
@@ -8856,7 +8879,7 @@
88568879
"/api/rest/2.0/report/liveboard": {
88578880
"post": {
88588881
"operationId": "exportLiveboardReport",
8859-
"description": "\n <span class=\"since-beta-tag\">Version: 9.0.0.cl or later</span>\n\nExports a Liveboard and its visualizations in PDF or PNG file format.\n\nRequires at least view access to the Liveboard.\n\n#### Usage guidelines\n\nIn the request body, specify the GUID or name of the Liveboard. To generate a Liveboard report with specific visualizations, add GUIDs or names of the visualizations.\n\nThe default `file_format` is PDF. For PDF downloads, you can specify additional parameters to customize the page orientation and include or exclude the cover page, logo, footer text, and page numbers. Similar customization options are also available for PNG output.\n\n**NOTE**: The downloadable file returned in API response file is extensionless. Please rename the downloaded file by typing in the relevant extension.\n\nOptionally, you can define [runtime overrides](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_overrides) to apply to the Answer data.\n\nTo include unsaved changes in the report, pass the `transient_pinboard_content` script generated from the `getExportRequestForCurrentPinboard` method in the Visual Embed SDK. Upon successful execution, the API returns the report with unsaved changes, including ad hoc changes to visualizations. For more information, see [Liveboard Report API](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_liveboard_report_api). \n\n**NOTE**: Starting with ThoughtSpot Cloud 10.9.0.cl release, the Liveboard can be exported in the PNG format in the resolution of your choice. To enable this on your instance, contact ThoughtSpot support. When this feature is enabled, the options `include_cover_page`,`include_filter_page` within the `png_options` will not be available for PNG exports.\n\n\n\n#### Endpoint URL\n",
8882+
"description": "\n <span class=\"since-beta-tag\">Version: 9.0.0.cl or later</span>\n\nExports a Liveboard and its visualizations in PDF, PNG, or CSV file format.\n\nRequires at least view access to the Liveboard.\n\n#### Usage guidelines\n\nIn the request body, specify the GUID or name of the Liveboard. To generate a Liveboard report with specific visualizations, add GUIDs or names of the visualizations.\n\nThe default `file_format` is CSV. For PDF exports, you can specify additional parameters to customize the page orientation and include or exclude the cover page, logo, footer text, and page numbers. Similar customization options are available for PNG exports. CSV exports do not support customization options.\n\n**NOTE**: The downloadable file returned in API response file is extensionless. Please rename the downloaded file by typing in the relevant extension.\n\nOptionally, you can define [runtime overrides](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_overrides) to apply to the Answer data.\n\nTo include unsaved changes in the report, pass the `transient_pinboard_content` script generated from the `getExportRequestForCurrentPinboard` method in the Visual Embed SDK. Upon successful execution, the API returns the report with unsaved changes, including ad hoc changes to visualizations. For more information, see [Liveboard Report API](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_liveboard_report_api). \n\n**NOTE**: Starting with ThoughtSpot Cloud 10.9.0.cl release, the Liveboard can be exported in the PNG format in the resolution of your choice. To enable this on your instance, contact ThoughtSpot support. When this feature is enabled, the options `include_cover_page`,`include_filter_page` within the `png_options` will not be available for PNG exports.\n\n**NOTE**: Starting with the ThoughtSpot Cloud 26.2.0.cl release, Liveboards can be exported in CSV format. All visualizations in the Liveboard can be exported as individual CSV files. If multiple visualizations are selected or if the entire Liveboard is exported, the output is returned as a .zip file containing the CSV files for each visualization.\n\n\n\n\n#### Endpoint URL\n",
88608883
"tags": [
88618884
"Reports",
88628885
"9.0.0.cl"
@@ -8899,7 +8922,8 @@
88998922
"type": "string",
89008923
"enum": [
89018924
"PDF",
8902-
"PNG"
8925+
"PNG",
8926+
"CSV"
89038927
]
89048928
},
89058929
"runtime_filter": {
@@ -12313,7 +12337,9 @@
1231312337
"examples": {
1231412338
"example_1": {
1231512339
"value": {
12316-
"onboarding_content_url": ""
12340+
"onboarding_content_url": "",
12341+
"saml_enabled": false,
12342+
"okta_enabled": false
1231712343
}
1231812344
}
1231912345
}
@@ -14545,7 +14571,7 @@
1454514571
"/api/rest/2.0/template/variables/create": {
1454614572
"post": {
1454714573
"operationId": "createVariable",
14548-
"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",
14574+
"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",
1454914575
"tags": [
1455014576
"Variable",
1455114577
"10.14.0.cl"
@@ -14577,7 +14603,7 @@
1457714603
"nullable": true
1457814604
},
1457914605
"data_type": {
14580-
"description": "Variable Data Type",
14606+
"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>",
1458114607
"type": "string",
1458214608
"enum": [
1458314609
"VARCHAR",
@@ -17174,6 +17200,14 @@
1717417200
"onboarding_content_url": {
1717517201
"type": "string",
1717617202
"nullable": true
17203+
},
17204+
"saml_enabled": {
17205+
"type": "boolean",
17206+
"nullable": true
17207+
},
17208+
"okta_enabled": {
17209+
"type": "boolean",
17210+
"nullable": true
1717717211
}
1717817212
}
1717917213
},
@@ -22380,15 +22414,15 @@
2238022414
}
2238122415
}
2238222416
},
22383-
"InvalidateConnectionTokensResponse": {
22417+
"RevokeRefreshTokensResponse": {
2238422418
"type": "object",
2238522419
"required": [
22386-
"revoke_result"
22420+
"data"
2238722421
],
2238822422
"properties": {
22389-
"revoke_result": {
22423+
"data": {
2239022424
"type": "string",
22391-
"description": "Result message describing the outcome of the token revocation operation."
22425+
"description": "Result message describing the outcome of the refresh token revocation operation."
2239222426
}
2239322427
}
2239422428
},

0 commit comments

Comments
 (0)