addUserToTopicRole command

Use the addUserToTopicRole command to add a user to a topic role within a specified topic space.

To run the command, use the AdminTask object of the wsadmin scripting client.

This command is valid only when used with WebSphere® Application Server Version 7.0 or later application servers. Do not use it with earlier versions.

Command-line help is provided for service integration bus commands:
  • For a list of the available service integration bus security commands in Jython and a brief description of each command, enter the following command at the wsadmin prompt:

    print AdminTask.help('SIBAdminBusSecurityCommands')

  • For overview help on a given command, enter the following command at the wsadmin prompt:

    print AdminTask.help('command_name')

After using the command, save your changes to the master configuration; for example, by using the following command:


AdminConfig.save()

Purpose

Use the addUserToTopicRole command to add a user to the sender or receiver roles for a topic anywhere in the topic hierarchy for a local bus. The roles that you specify for the topic are additional to any roles that the topic inherits from its parent in the topic hierarchy.

You can use this command to define the access control policy for a topic that does not yet exist. By defining the access control policy first, you ensure that the topic is secure from the moment it is created.

Target object

None.

Required parameters

-bus busName
The name of the local bus. You can use the listSIBuses command to list the names of existing buses.
-topicSpace topicSpaceName
The name of the topic space.
-topic topicName
The name of the topic.
-role roleName
You can specify the Sender or Receiver roles for a topic.
-user userName
The name of the user that you want to add to the Sender or Receiver roles for a topic.

Conditional parameters

None.

Optional parameters

-uniqueName uniqueName
Specify the name that uniquely defines the user in the user registry. If an LDAP user registry is in use, the unique name is the distinguished name (DN) for the user. You can specify values for both -uniqueName and -user, but you must ensure that they identify the same user. The command does not check that the values match.

Example

The following example adds a user called User1, to the Sender role for a topic called football, in the topic space called Sport, on a local bus called Bus1.

Admintask.addUserToTopicRole ('[-bus Bus1 -topicSpace Sport -topic football -role Sender -user User1]')



Related concepts
Messaging security
Topic security
Role-based authorization
Related tasks
Adding users and groups to topic roles
Reference topic Reference topic    

Terms of Use | Feedback

Last updatedLast updated: Sep 19, 2011 6:15:55 PM CDT
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=matt&product=was-express-dist&topic=rjr_add_usr_topic_role
File name: rjr_add_usr_topic_role.html