addUserToDefaultRole command
Use the addUserToDefaultRole command to add a user to the default roles for a local bus.
To run the command, use the AdminTask object of the wsadmin scripting client.
The wsadmin scripting client is run from Qshell.
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.
- 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:
Purpose
Use the addUserToDefaultRole command to grant a user default access to all local bus destinations for the specified roles. Adding a user to the default role does not grant access to local destinations where the inheritance of default access is disallowed. To grant access to a local destination where inheritance is disallowed, you must add the user to a destination role. For more information, see addUserToDestinationRole command.
You can use this command to define the access control policy for a messaging resource that does not yet exist. This approach ensures that the messaging resource 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.
- -role roleType
- The role type to which you want to assign the user. You can assign
a user to the following role types:
- 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.
- Creator
- This role type is authorized to create messages on destinations on the local bus.
- -user userName
- The name of a user you want to add to the bus connector role for the local bus.
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.
Examples
The following example adds a user
called User1
to the sender role type for a bus called Bus1
.
AdminTask.addUserToDefaultRole ('[-bus Bus1 -role Sender -user User1]')