RuntimeServiceAddGroupsToUser Method |
Adds groups to a user. Intended for web use only.
Namespace: Advantys.Workflow.Web.Services.Processes.Runtime
Assembly: Advantys.Workflow.Web.Services.Processes.Runtime (in Advantys.Workflow.Web.Services.Processes.Runtime.dll) Version: 7.10.0.0 (7.10.0.0)
SyntaxParameters
- username
- Type: SystemString
Username - groupsDefinition
- Type: SystemString
Definition of groups to associate to the user. Element names are case sensitive.
RemarksAvailable since WorkflowGen version: 6.2.0
These parameters can be used in the query string or as parameters of the Headers object in the RuntimeService class instance. See example below.
Sample groups definition:
Sample code:
The method receives a list of groups to associate to the user. Groups must be in the same directory as the user directory. For parameters that support both a name and an id, the name will be ignored if an id is set.
Optional Parameters.These parameters can be used in the query string or as parameters of the Headers object in the RuntimeService class instance. See example below.
| UserId (int) | Specifies the user id. Supercedes the username. |
| IgnoreMissingAssociations (bool) | Sets whether or not to return an error when an association (group) is missing from the target. Default = true. |
Sample groups definition:
<Groups> <Group> <Name>Group1</Name> </Group> <Group> <Name>Group2</Name> </Group> </Groups>
Sample code:
RuntimeServiceWebService.RuntimeService myRuntimeService = new RuntimeServiceWebService.RuntimeService(); RuntimeServiceWebService.UserHeader myUserHeader = new RuntimeServiceWebService.UserHeader(); myRuntimeService.UserHeaderValue = myUserHeader; myUserHeader.IgnoreMissingAssociations = ignoreMissingAssociations; myRuntimeService.AddGroupsToUser(username, groupsDefinition);
See Also