SetBusinessSystemUserRequest Class
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Contains the data that is needed to move a system user (user) to a different business unit.
For the Web API use the SetBusinessSystemUser Action.
Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)
Inheritance Hierarchy
System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.SetBusinessSystemUserRequest
Syntax
[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class SetBusinessSystemUserRequest : OrganizationRequest
<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class SetBusinessSystemUserRequest
Inherits OrganizationRequest
Constructors
Name | Description | |
---|---|---|
SetBusinessSystemUserRequest() | Initializes a new instance of the SetBusinessSystemUserRequest class. |
Properties
Name | Description | |
---|---|---|
BusinessId | Gets or sets the ID of the business unit to which the user is moved. Required. |
|
ExtensionData | Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.) |
|
Item[String] | Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.) |
|
Parameters | Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.) |
|
ReassignPrincipal | Gets or sets the target security principal (user) to which the instances of entities previously owned by the user are to be assigned. Required. |
|
RequestId | Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.) |
|
RequestName | Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.) |
|
UserId | Gets or sets the ID of the user. Required. |
Methods
Name | Description | |
---|---|---|
Equals(Object) | (Inherited from Object.) |
|
GetHashCode() | (Inherited from Object.) |
|
GetType() | (Inherited from Object.) |
|
ToString() | (Inherited from Object.) |
Remarks
Important
This message request is deprecated. Consider using the UpdateRequest instead. For more information see Perform specialized operations using Update.
Message Availability
For this message to work, the caller must be connected to the server.
Usage
Pass an instance of this class to the Execute method, which returns an instance of SetBusinessSystemUserResponse.
Privileges and Access Rights
To perform this action, the caller must have privileges on the SystemUser entity and access rights on the records specified in the BusinessId and UserId properties. For a list of the privileges required, see SetBusinessSystemUser message privileges.
Notes for Callers
You must specify a value for the ReassignPrincipal property. The instances of the entities that had been assigned to the user specified by the UserId property will be assigned to that security principal (user).
If any of the direct reports of the user are no longer in the new business unit hierarchy after the user is moved, these direct reports are updated to report to the previous manager of the user.
If the user has been moved out of his or her manager's business-unit hierarchy, the manager of the user is set to null. You may list the same user for both the UserId and ReassignPrincipal properties if you would like the user to retain the entities assigned.
Thread Safety
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also
SetBusinessSystemUserResponse
Microsoft.Crm.Sdk.Messages Namespace
Administration and security entities
SystemUser (user) entity messages and methods
Return to top
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright