Update for 2021 Update 11 release

docs/common-workflows/administration/manage-application-objects/manage-application-customized-emails.md

@@ -15,6 +15,12 @@ Get the authorization token needed to execute the request with [POST /api/auth/l
 
 :::
 
+:::info
+
+The [DssXmlPrivilegesManageApplication](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesManageApplication) privilege is required to manage application customized emails.
+
+:::
+
 ## Create an application with customized email
 
 The following table lists important fields in the email settings.

docs/common-workflows/administration/manage-application-objects/manage-application-general-settings.md

@@ -13,6 +13,12 @@ Get the authorization token needed to execute the request with [POST /api/auth/l
 
 :::
 
+:::info
+
+The [DssXmlPrivilegesManageApplication](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesManageApplication) privilege is required to manage an application's general settings.
+
+:::
+
 ## Create an application
 
 Let's create a general application named company A.

docs/common-workflows/administration/manage-application-objects/manage-application-themes.md

@@ -17,6 +17,12 @@ Get the authorization token needed to execute the request with
 
 :::
 
+:::info
+
+The [DssXmlPrivilegesManageApplication](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesManageApplication) privilege is required to manage application themes.
+
+:::
+
 ## Create an application with customized theme
 
 The following table lists important fields in the theme object.

docs/common-workflows/administration/manage-content-group-objects/create-a-content-group.md

@@ -15,6 +15,12 @@ Get the authorization token needed to execute the request with [POST /api/auth/l
 
 :::
 
+:::info
+
+The [DssXmlPrivilegesManageContentBundle](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesManageContentBundle) privilege is required to create a content group.
+
+:::
+
 Endpoint: [POST /api/contentGroups](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Content%20Groups/createContentGroup)
 
 Sample Request Header:

docs/common-workflows/administration/manage-content-group-objects/update-a-content-group.md

@@ -15,6 +15,12 @@ Get the authorization token needed to execute the request with [POST /api/auth/l
 
 :::
 
+:::info
+
+The [DssXmlPrivilegesManageContentBundle](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesManageContentBundle) privilege is required to update a content group.
+
+:::
+
 Endpoint: [PATCH /api/contentGroups/{id}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Content%20Groups/updateContentGroup)
 
 Sample Request Header:

docs/common-workflows/administration/manage-content-group-objects/update-contents-of-an-existing-content-group.md

@@ -17,6 +17,12 @@ Get the project ID from [GET /api/projects](https://demo.microstrategy.com/Micro
 
 :::
 
+:::info
+
+The [DssXmlPrivilegesManageContentBundle](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesManageContentBundle) privilege is required to update the contents of a content group.
+
+:::
+
 Endpoint: [PATCH /api/contentGroups/{id}/contents](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Content%20Groups/updateContentGroupContent)
 
 Sample Request Header:

docs/common-workflows/administration/migrations/migrations-in-workstation/validate-migrations.md

@@ -25,6 +25,13 @@ Only Administrator users can validate migrations. Administrators must have the f
 
 To execute the API, you must get the authorization token by executing the `POST /api/auth/login` request, and get a token as `"X-MSTR-AuthToken": "ns42kvi9lb36ae7g3scphn0ga9"` in the response body. Keep the token value. It is required to execute the REST API. See [Authentication](/docs/getting-started/authentication.md) for more information.
 
+:::info
+
+The [DssXmlPrivilegesCreatePackage](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesCreatePackage) or [DssXmlPrivilegesApplyPackage](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesApplyPackage) privilege is required
+to get the details of a migration record or update a migration.
+
+:::
+
 ## Use scenarios
 
 The best practice scenario is when Workstation uses one Library server as a source and another Library server as a target. The source and target environments can be the same.

docs/common-workflows/administration/monitors/manage-an-intelligence-server-cluster.md

@@ -26,6 +26,12 @@ Intelligence Server provides you the functionality to cluster a group of Intelli
   - Make sure no other user is connected to Library Server and Intelligence Server nodes. Editing cluster membership is an administrative action and should be performed exclusively.
   - Make sure all Intelligence Server nodes are running during the life-time of Library Server. If some Intelligence Server nodes are/were down, you can start them first and then restart Library Server. This ensures changes are synchronized in a timely manner.
 
+:::info
+
+The [DssXmlPrivilegesUseClusterMonitor](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesUseClusterMonitor) and [DssXmlPrivilegesClusterAdministration](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesClusterAdministration) privileges are required to manage nodes from the connected Intelligence Server cluster.
+
+:::
+
 ## List nodes
 
 Endpoint: [GET /api/monitors/iServer/nodes](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Monitors/getClusterNodes)
@@ -128,3 +134,61 @@ Use the exact name returned by `GET /api/monitors/iServer/nodes`
   - **Success**: 204 No Content
   - **Timeout, still in-progress**: 202 Accepted
   - **Node not a member**: 404 Not Found
+
+## Cluster startup membership
+
+The endpoints: [PUT /api/monitors/iServer/nodes/{name}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Monitors/addServerClusterMember) and [DELETE /api/monitors/iServer/nodes/{name}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Monitors/removeServerClusterMember) allow to add or remove a node from a working cluster. The changes introduced by the endpoints aren't permanent. When a cluster is being restarted the cluster setup will be restored to the cluster startup membership configuration from metadata. In order to display the configuration, you can use a following endpoint: [GET /api/iserver/clusterStartupMembership](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/System%20Administration/getClusterStartupMembership)
+
+This operation requires "Cluster Administration" privilege.
+
+| Parameter        | Description         | Parameter Type | Data Type | Required |
+| ---------------- | ------------------- | -------------- | --------- | -------- |
+| X-MSTR-AuthToken | Authorization token | Header         | String    | Yes      |
+
+- Response: 200 (Success : OK)
+
+### Sample response body
+
+```json
+{
+  "clusterStartupMembership": [
+    "i-server-hostname-1",
+    "i-server-hostname-2",
+    "i-server-hostname-3",
+    "i-server-hostname-4"
+  ]
+}
+```
+
+## Cluster startup membership update
+
+There is also a dedicated [PUT /api/iserver/clusterStartupMembership](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/System%20Administration/getClusterStartupMembership) endpoint to update cluster startup membership configuration.
+
+This operation requires the "Cluster Administration" privilege.
+
+| Parameter        | Description         | Parameter Type | Data Type | Required |
+| ---------------- | ------------------- | -------------- | --------- | -------- |
+| X-MSTR-AuthToken | Authorization token | Header         | String    | Yes      |
+
+- Response:
+  - **Success**: 200 OK
+  - **Incorrect list of host names**: 400 Bad Request
+
+### Sample request body
+
+```json
+{
+  "clusterStartupMembership": [
+    "i-server-hostname-A",
+    "i-server-hostname-B",
+    "i-server-hostname-C",
+    "i-server-hostname-D"
+  ]
+}
+```
+
+:::tip
+
+The `PUT` endpoint return updated startup configuration of the cluster in the response.
+
+:::

docs/common-workflows/administration/monitors/manage-caches.md

@@ -18,6 +18,12 @@ When a user works with MicroStrategy, cache data is created. The data stored in
 
 - `DELETE /api/monitors/projects/{projectId}/cache/{cacheType}`
 
+:::info
+
+The [DssXmlPrivilegesCacheAdministration](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesCacheAdministration) privilege is required to purge element or object caches.
+
+:::
+
 ## API
 
 The sections below present Cache Management REST API usage.
@@ -102,9 +108,9 @@ Please find the `id` for the desired project. For example, `id` of the project:
 
 You need to invoke a following endpoint to delete the cache:
 
-Endpoint: [DELETE /api/monitors/projects/{projectId}/cache/{cacheType}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Monitors/deleteCache)
+Endpoint: [DELETE /api/monitors/projects/{projectId}/caches/{cacheType}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Monitors/deleteCache)
 
-The endpoint path consists of `projectId` parameter, so you need to replace the placeholder by the `id` value. The last placeholder determines cache type which will be purged. The allowable values are following `element` or `cache`. The example below demonstrates how to call the endpoint using curl command:
+The endpoint path consists of the `projectId` parameter, so you must replace the placeholder with the `id` value. The last placeholder determines the cache type to be purged. The allowable values follow `element` or `cache`. The example below demonstrates how to call the endpoint using a curl command:
 
 ```bash
 curl -X 'DELETE' \

docs/common-workflows/administration/monitors/project-administration.md

@@ -11,6 +11,12 @@ Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/
 
 :::
 
+:::info
+
+The [DssXmlPrivilegesUseClusterMonitor](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesUseClusterMonitor) privilege is required to fetch information about nodes in the connected Intelligence Server cluster.
+
+:::
+
 The following sequence of REST API requests allows an administrator to manage project distribution and configuration:
 
 ## Log in

docs/common-workflows/administration/server-management/manage-languages.md

@@ -13,6 +13,12 @@ Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/
 
 :::
 
+:::info
+
+The [DssXmlPrivilegesCreateConfigObj](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesCreateConfigObj) privilege is required to create a new language object.
+
+:::
+
 ## 1. Get server supported langauges
 
 Endpoint: [GET /api/iserver/baseLanguages](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Languages/getSupportedLanguages)

docs/common-workflows/administration/server-management/manage-server-settings.md

@@ -15,6 +15,12 @@ Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/
 
 A high-level workflow sample for managing server settings is shown below. The sequence of REST API requests in the following procedure allows an administrative user to manage the Intelligence Server settings.
 
+:::info
+
+The [DssXmlPrivilegesConfigureGoverning](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesConfigureGoverning) and [DssXmlPrivilegesConfigureServerBasic](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesConfigureServerBasic) privileges are required to manage server settings.
+
+:::
+
 A detailed explanation of each step is provided below.
 
 ## Log in

docs/common-workflows/administration/server-management/server-level-privileges/manage-server-level-privileges.md

@@ -13,6 +13,12 @@ Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/
 
 A high-level workflow sample for managing server-level privileges is shown below. The sequence of REST API requests in the following procedure allows an administrative user to get server-level privilege information for a specific user or user group, grant new server-level privileges to the user, and revoke granted server-level privileges.
 
+:::info
+
+The [DssXmlPrivilegesUseUserManager](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesUseUserManager) privilege is required to retrieve user privileges.
+
+:::
+
 A detailed explanation of each step is provided below:
 
 ## Log in

docs/common-workflows/administration/user-management/create-and-update-user-groups.md

@@ -22,6 +22,12 @@ A workflow sample for managing user groups in the metadata is provided below. Th
 
 To make it easy for you to test this workflow in your environment, [download the zipped Postman script](https://www2.microstrategy.com/producthelp/2021/downloads/RESTSDK/PostmanScripts/ManagingUserGroups_postman_collection.zip) provided for you, extract the JSON file, and configure it to point to your Web server.
 
+:::info
+
+The [DssXmlPrivilegesUseUserManager](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesUseUserManager) privilege is required to create a new language object.
+
+:::
+
 A detailed explanation of each step is provided below:
 
 ## Log in

docs/common-workflows/administration/user-management/create-security-roles.md

@@ -24,6 +24,12 @@ Administrators can make REST API calls to perform a full set of operations on th
 
 To avoid security vulnerabilities, administrators should have a clear understanding of the privileges and security requirements of their system before assigning privileges which provide access to application functionality.
 
+:::info
+
+The [DssXmlPrivilegesUseSecurityRoleManager](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesUseSecurityRoleManager) privilege is required to manage the security role object.
+
+:::
+
 ## Creating a security role and managing privileges of a security role
 
 A workflow sample for creating a new security role in the metadata is provided below. The following sequence of REST API requests allows an administrator to create a new security role, and optionally get information about the security role to confirm the creation and updates.

docs/common-workflows/analytics/manage-reports/manage-report-objects/execute-report.md

@@ -15,6 +15,12 @@ Obtain the authorization token needed to execute the request using `POST /api/au
 
 You want to get the SQL view of a report with prompts. You can create a report instance and set the executionStage to resolve_prompts. Then after answering the prompts, the SQL view will be available.
 
+:::info
+
+The [DssXmlPrivilegesWebReportSQL](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesWebReportSQL) privilege is required to get the SQL view of a report instance.
+
+:::
+
 ### 1. Create a report instance with execution stage
 
 Endpoint: [POST /api/model/reports/{reportId}/instances](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Reports/ms-createReportInstance) with executionStage=resolve_prompts

docs/common-workflows/analytics/project-management/manage-project-load-settings-on-server-startup.md

@@ -13,6 +13,12 @@ Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/
 
 :::
 
+:::info
+
+The [DssXmlPrivilegesConfigureServerBasic](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesConfigureServerBasic) privilege is required to manage project load settings on Intelligence Server startup.
+
+:::
+
 A high-level workflow sample for loading project settings at the startup of the Intelligence Server is shown below.
 
 - [Log in](#log-in)

docs/common-workflows/analytics/retrieve-sql-statements-and-query-details/retrieve-dataset-sql.md

@@ -32,6 +32,12 @@ Get the project ID from [GET /api/projects](https://demo.microstrategy.com/Micro
 
 :::
 
+:::info
+
+The [DssXmlPrivilegesWebReportSQL](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesWebReportSQL) privilege is required to get the SQL view of a report instance.
+
+:::
+
 ## Create a dossier instance
 
 Use [POST /api/dossiers/{id}/instances](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Dossiers%20and%20Documents/createDossierInstance_2).

docs/common-workflows/analytics/retrieve-sql-statements-and-query-details/retrieve-report-or-card-sql.md

@@ -32,6 +32,12 @@ Get the project ID from [GET /api/projects](https://demo.microstrategy.com/Micro
 
 :::
 
+:::info
+
+The [DssXmlPrivilegesWebReportSQL](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesWebReportSQL) privilege is required to get the SQL view of a report instance.
+
+:::
+
 ## Create a report instance
 
 Use [POST /api/v2/reports/{id}/instances](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Reports/createReportInstance_1)

docs/common-workflows/analytics/retrieve-sql-statements-and-query-details/retrieve-visualization-query-details.md

@@ -32,6 +32,12 @@ Get the project ID from [GET /api/projects](https://demo.microstrategy.com/Micro
 
 :::
 
+:::info
+
+The [DssXmlPrivilegesWebReportSQL](https://www2.microstrategy.com/producthelp/Current/WebAPIReference/com/microstrategy/webapi/EnumDSSXMLPrivilegeTypes.html#DssXmlPrivilegesWebReportSQL) privilege is required to get the SQL view of a report instance.
+
+:::
+
 ## Create a dossier instance
 
 Use [POST /api/dossiers/{id}/instances](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Dossiers%20and%20Documents/createDossierInstance_2)