Category Component 25.2
Category Component Help

# ClusterSetAccessPermissions

Allows you to create access permissions for using and viewing cluster output. You can add permissions for a particular role to use and view particular clustering output.

When you set access permissions, you use the Username parameter to specify a user that performs the action. If the specified user does not belong to an allowed role, the Category component returns an authorization error.

If you do not set permissions, all users can perform the actions, and you do not need to specify the Username parameter.

NOTE: This is an administrative action that can be sent only by users that belong to an authorization role that allows the `Admin` standard role, or which enables the action explicitly. See Authorization Roles Configuration Parameters.

## Example

    http://12.3.4.56:9020/action=ClusterSetAccessPermissions&Role=admin&ClusterOutputType=cluster&SourceJobName-myclusters

This action specifies that only members of the `admin` role can view clusters from the `myclusters` job.

## Required Parameters

The following action parameters are required.

Parameter | Description
--- | ---
ClusterOutputType | The output type to restrict permissions for.
Role | The role to change permissions for.
SourceJobName | The cluster to apply the permissions to.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
AddRolesToAccess | Whether to add access for the specified Role.

This action accepts the following standard ACI action parameters.

Parameter | Description
--- | ---
ActionID | A string to use to identify an ACI action.
FileName | The file to write output to.
ForceTemplateRefresh | Forces the server to load the template from disk.
Output | Writes output to a file.
ResponseFormat | The format of the action output.
Template | The template to use for the action output.
TemplateParamCSVs | A list of variables to use for the specified template.

Copyright 2025 Open Text
Version 25.2 | Last updated April 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery Category Component 25.2

Topic Title: ClusterSetAccessPermissions