removeUserFromDestinationRole command

Use the removeUserFromDestinationRole command to remove a user from the destination roles for a local or foreign bus.

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

[IBM i][IBM i]The wsadmin scripting client is run from Qshell.

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 by using the following command:

AdminConfig.save()

Purpose

Use the removeUserFromDestinationRole command to remove a user from destination roles for a selected local bus. By removing a user from destination roles, you prevent the user from accessing the local bus.

Target object

None.

Required parameters

-type destinationType
You can specify one of the following destination types:
  • Queue
  • Port
  • TopicSpace
  • ForeignDestination
  • Alias

The allowed roles for a destination depend on the type of the destination as defined in Administering destination roles.

If you are specifying a destinationType that is either foreignDestination or alias, the foreign bus name that you specify must be the name of the foreign bus hosting the destination.

If you specify a destinationType of queue or topic, the foreign bus name is ignored. The authorization is granted against the destination in the local bus.

-bus busName
The name of the local bus. You can use the listSIBuses command to list the names of existing buses.
-role roleType
You can specify one of the following role types, depending on the -type you have specified.
Sender
This role type is authorized to send messages to destinations on the local bus.
Receiver
This role type is authorized to receive messages from destinations on the local bus.
Browser
This role type is authorized to browse messages on destinations on the local bus.
-user userName or uniqueName
The name of a user you want to remove from the destination roles for the local bus. You can type one of the following names:
  • A security user name.
  • A unique user name.

Conditional parameters

None.

Optional parameters

-foreignBus foreignBusName
Specify the name of the foreign bus. If you are removing a user from a destination role on a foreign destination or an alias, you must specify the name of the foreign bus that hosts the foreign destination or the alias.

Examples

The following example removes a user called User1 from the Sender role for a queue type destination called Queue1, on a local bus called Bus1.

AdminTask.removeUserFromDestinationRole ('[-type queue -bus Bus1
 -destination Queue1 -role Sender -user User1]')

The following example removes a user called User2 from the Receiver role for a queue type destination called Queue2, on a local bus called Bus1.

AdminTask.removeUserFromDestinationRole ('[-type queue -bus Bus1
 -destination Queue2 -role Receiver -user User2]')