|
2844 | 2844 | }, |
2845 | 2845 | "/api/rest/2.0/connections/refresh-tokens/revoke": { |
2846 | 2846 | "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\nUser should have Administrative Privilege or be the Connection Author to revoke the refresh tokens.\n\n## Token Revocation Rules\n\nYou can specify different combinations of identifiers to control\nwhich refresh tokens are revoked:\n\n- **connection_identifier only**: All user's refresh tokens will be\n revoked except the connection author.\n- **connection_identifier + user_identifiers**: Only specified user's\n refresh tokens will be revoked. If the author's user_identifier is\n included, their token will also be revoked.\n- **connection_identifier + configuration_identifiers**: Refresh\n tokens for the specified configurations will be revoked.\n- **connection_identifier + org_identifiers**: Refresh tokens for the\n specified orgs will be revoked. 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 revoked, logged-in users will need to re-authenticate to access visualizations.\n\n\n\n\n#### Endpoint URL\n", |
2849 | 2849 | "tags": [ |
2850 | 2850 | "Connections", |
2851 | 2851 | "26.2.0.cl" |
|
2857 | 2857 | "type": "object", |
2858 | 2858 | "properties": { |
2859 | 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.", |
| 2860 | + "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.", |
2861 | 2861 | "type": "string" |
2862 | 2862 | }, |
2863 | 2863 | "configuration_identifiers": { |
2864 | | - "description": "Unique ID or name of configurations. If provided, the specified configuration's user tokens will be deleted.", |
| 2864 | + "description": "Unique ID or name of configurations. If provided, the specified configuration's user refresh tokens will be revoked.", |
2865 | 2865 | "type": "array", |
2866 | 2866 | "items": { |
2867 | 2867 | "type": "string" |
2868 | 2868 | } |
2869 | 2869 | }, |
2870 | 2870 | "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.", |
| 2871 | + "description": "Unique ID or name of users. If provided, only the specified user's refresh tokens will be revoked. If the author's user_identifier is included, their token will also be revoked.", |
2872 | 2872 | "type": "array", |
2873 | 2873 | "items": { |
2874 | 2874 | "type": "string" |
2875 | 2875 | } |
2876 | 2876 | }, |
2877 | 2877 | "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.", |
| 2878 | + "description": "Unique ID or name of orgs. This is applicable only for published connections. If provided, the specified org's user refresh tokens will be revoked. This field is only valid for published connections; using it with unpublished connections will return an error.", |
2879 | 2879 | "type": "array", |
2880 | 2880 | "items": { |
2881 | 2881 | "type": "string" |
|
2897 | 2897 | "content": { |
2898 | 2898 | "application/json": { |
2899 | 2899 | "schema": { |
2900 | | - "$ref": "#/components/schemas/InvalidateConnectionTokensResponse" |
| 2900 | + "$ref": "#/components/schemas/RevokeRefreshTokensResponse" |
2901 | 2901 | } |
2902 | 2902 | } |
2903 | 2903 | } |
|
5366 | 5366 | "/api/rest/2.0/customization/email": { |
5367 | 5367 | "post": { |
5368 | 5368 | "operationId": "createEmailCustomization", |
5369 | | - "description": "\n<span class=\"since-beta-tag\">Beta</span> <span class=\"since-beta-tag\">Version: 10.10.0.cl or later</span>\n\nCreates a customization configuration for the notification email.\n\n#### Pre-requisites\n\nRequires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required.\n\n**NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance.\n\n#### Usage guidelines\n\nTo create a custom configuration pass these parameters in your API request:\n\n- A JSON map of configuration attributes `template_properties`. The following example shows a sample set of customization configuration:\n\n```\n{\n {\n \"cta_button_bg_color\": \"#444DEA\",\n \t\"cta_text_font_color\": \"#FFFFFF\",\n \t\"primary_bg_color\": \"#D3DEF0\",\n \"logo_url\": \"https://storage.pardot.com/710713/1642089901EbkRibJq/TS_fullworkmark_darkmode.png\",\n \t \"font_family\": \"\",\n \t\"product_name\": \"ThoughtSpot\",\n \t\"footer_address\": \"444 Castro St, Suite 1000 Mountain View, CA 94041\",\n\t \"footer_phone\": \"(800) 508-7008\",\n \"replacement_value_for_liveboard\": \"Dashboard\",\n \t\"replacement_value_for_answer\": \"Chart\",\n \t\"replacement_value_for_spot_iq\": \"AI Insights\",\n \t \"hide_footer_phone\": false,\n \"hide_footer_address\": false,\n \"hide_product_name\": false,\n \t\"hide_manage_notification\": false,\n \t\"hide_mobile_app_nudge\": false,\n \t\"hide_privacy_policy\": false,\n \t\"hide_ts_vocabulary_definitions\": false,\n \t\"hide_error_message\": false,\n \t\"hide_unsubscribe_link\": false,\n \"hide_notification_status\": false,\n \t\"hide_modify_alert\": false,\n \t\"company_website_url\": \"https://your-website.com/\",\n \t\"company_privacy_policy_url\" : \"https://link-to-privacy-policy.com/\",\n \"contact_support_url\": \"https://link-to-contact-support.com/\",\n \"hide_contact_support_url\": false\n }\n}\n```\n\n\n\n\n#### Endpoint URL\n", |
| 5369 | + "description": "\n<span class=\"since-beta-tag\">Beta</span> <span class=\"since-beta-tag\">Version: 10.10.0.cl or later</span>\n\nCreates a customization configuration for the notification email.\n\n#### Pre-requisites\n\nRequires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required.\n\n**NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance.\n\n#### Usage guidelines\n\nTo create a custom configuration pass these parameters in your API request:\n\n- A JSON map of configuration attributes `template_properties`. The following example shows a sample set of customization configuration:\n\n```\n{\n {\n \"ctaButtonBgColor\": \"#444DEA\",\n \"ctaTextFontColor\": \"#FFFFFF\",\n \"primaryBgColor\": \"#D3DEF0\",\n \"hideMobileAppNudge\": false,\n \"fontFamily\" : \"\",\n \"hideProductName\" : false,\n \"hideFooterPhone\" : false,\n \"hideFooterAddress\" : false,\n \"hidePrivacyPolicy\" : false,\n \"hideManageNotification\" : false,\n \"hideTsVocabularyDefinitions\": false,\n \"hideNotificationStatus\" : false,\n \"hideErrorMessage\": false,\n \"hideUnsubscribeLink\" : false,\n \"hideModifyAlert\": false,\n \"textTransform\": \"\",\n \"replacementValueForLiveboard\": \"LB dashboard\",\n \"replacementValueForAnswer\": \"Answer dashboard\",\n \"replacementValueForSpotIQ\": \"SpotIQ dashboard\",\n \"logoUrl\":\"\",\n \"productName\":\"ThoughtSpot\",\n \"footerPhone\":\"(800) 508-7008\",\n \"footerAddress\":\"444 Castro St, Suite 1000 Mountain View, CA 94041\",\n \"companyWebsiteUrl\":\"\",\n \"companyPrivacyPolicyUrl\":\"\"\n }\n}\n```\n\n\n\n\n#### Endpoint URL\n", |
5370 | 5370 | "tags": [ |
5371 | 5371 | "Email Customization", |
5372 | 5372 | "10.10.0.cl" |
|
5653 | 5653 | "/api/rest/2.0/customization/email/update": { |
5654 | 5654 | "post": { |
5655 | 5655 | "operationId": "updateEmailCustomization", |
5656 | | - "description": "\n<span class=\"since-beta-tag\">Beta</span> <span class=\"since-beta-tag\">Version: 10.12.0.cl or later</span>\n\nUpdates a customization configuration for the notification email.\n\n#### Pre-requisites\n\nRequires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required.\n\n**NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance.\n\n#### Usage guidelines\n\nTo update a custom configuration pass these parameters in your API request:\n\n- A JSON map of configuration attributes `template_properties`. The following example shows a sample set of customization configuration:\n\n```\n{\n {\n \"cta_button_bg_color\": \"#444DEA\",\n \t\"cta_text_font_color\": \"#FFFFFF\",\n \t\"primary_bg_color\": \"#D3DEF0\",\n \"logo_url\": \"https://storage.pardot.com/710713/1642089901EbkRibJq/TS_fullworkmark_darkmode.png\",\n \t \"font_family\": \"\",\n \t\"product_name\": \"ThoughtSpot\",\n \t\"footer_address\": \"444 Castro St, Suite 1000 Mountain View, CA 94041\",\n\t \"footer_phone\": \"(800) 508-7008\",\n \"replacement_value_for_liveboard\": \"Dashboard\",\n \t\"replacement_value_for_answer\": \"Chart\",\n \t\"replacement_value_for_spot_iq\": \"AI Insights\",\n \t \"hide_footer_phone\": false,\n \"hide_footer_address\": false,\n \"hide_product_name\": false,\n \t\"hide_manage_notification\": false,\n \t\"hide_mobile_app_nudge\": false,\n \t\"hide_privacy_policy\": false,\n \t\"hide_ts_vocabulary_definitions\": false,\n \t\"hide_error_message\": false,\n \t\"hide_unsubscribe_link\": false,\n \"hide_notification_status\": false,\n \t\"hide_modify_alert\": false,\n \t\"company_website_url\": \"https://your-website.com/\",\n \t\"company_privacy_policy_url\" : \"https://link-to-privacy-policy.com/\",\n \"contact_support_url\": \"https://link-to-contact-support.com/\",\n \"hide_contact_support_url\": false\n }\n}\n```\n\n\n\n\n#### Endpoint URL\n", |
| 5656 | + "description": "\n<span class=\"since-beta-tag\">Beta</span> <span class=\"since-beta-tag\">Version: 10.12.0.cl or later</span>\n\nUpdates a customization configuration for the notification email.\n\n#### Pre-requisites\n\nRequires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required.\n\n**NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance.\n\n#### Usage guidelines\n\nTo update a custom configuration pass these parameters in your API request:\n\n- A JSON map of configuration attributes `template_properties`. The following example shows a sample set of customization configuration:\n\n```\n{\n {\n \"ctaButtonBgColor\": \"#444DEA\",\n \"ctaTextFontColor\": \"#FFFFFF\",\n \"primaryBgColor\": \"#D3DEF0\",\n \"hideMobileAppNudge\": false,\n \"fontFamily\" : \"\",\n \"hideProductName\" : false,\n \"hideFooterPhone\" : false,\n \"hideFooterAddress\" : false,\n \"hidePrivacyPolicy\" : false,\n \"hideManageNotification\" : false,\n \"hideTsVocabularyDefinitions\": false,\n \"hideNotificationStatus\" : false,\n \"hideErrorMessage\": false,\n \"hideUnsubscribeLink\" : false,\n \"hideModifyAlert\": false,\n \"textTransform\": \"\",\n \"replacementValueForLiveboard\": \"LB dashboard\",\n \"replacementValueForAnswer\": \"Answer dashboard\",\n \"replacementValueForSpotIQ\": \"SpotIQ dashboard\",\n \"logoUrl\":\"\",\n \"productName\":\"ThoughtSpot\",\n \"footerPhone\":\"(800) 508-7008\",\n \"footerAddress\":\"444 Castro St, Suite 1000 Mountain View, CA 94041\",\n \"companyWebsiteUrl\":\"\",\n \"companyPrivacyPolicyUrl\":\"\"\n }\n}\n```\n\n\n\n\n#### Endpoint URL\n", |
5657 | 5657 | "tags": [ |
5658 | 5658 | "Email Customization", |
5659 | 5659 | "10.12.0.cl" |
@@ -22380,15 +22380,15 @@ |
22380 | 22380 | } |
22381 | 22381 | } |
22382 | 22382 | }, |
22383 | | - "InvalidateConnectionTokensResponse": { |
| 22383 | + "RevokeRefreshTokensResponse": { |
22384 | 22384 | "type": "object", |
22385 | 22385 | "required": [ |
22386 | 22386 | "revoke_result" |
22387 | 22387 | ], |
22388 | 22388 | "properties": { |
22389 | 22389 | "revoke_result": { |
22390 | 22390 | "type": "string", |
22391 | | - "description": "Result message describing the outcome of the token revocation operation." |
| 22391 | + "description": "Result message describing the outcome of the refresh token revocation operation." |
22392 | 22392 | } |
22393 | 22393 | } |
22394 | 22394 | }, |
|
23899 | 23899 | "type": "string", |
23900 | 23900 | "description": "Company website URL (HTTP/HTTPS only)", |
23901 | 23901 | "nullable": true |
23902 | | - }, |
23903 | | - "contact_support_url": { |
23904 | | - "type": "string", |
23905 | | - "description": "Contact support url (HTTP/HTTPS only).", |
23906 | | - "nullable": true |
23907 | | - }, |
23908 | | - "hide_contact_support_url": { |
23909 | | - "type": "boolean", |
23910 | | - "description": "Whether to hide contact support url.", |
23911 | | - "nullable": true |
23912 | 23902 | } |
23913 | 23903 | }, |
23914 | 23904 | "description": "Email customization configuration properties" |
|
0 commit comments