SetBusinessSystemUserRequest Class

Reference

Definition

Namespace:: Microsoft.Crm.Sdk.Messages

Assembly:: Microsoft.Crm.Sdk.Proxy.dll

Package:: Microsoft.PowerPlatform.Dataverse.Client v1.0.1

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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.

public ref class SetBusinessSystemUserRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest

[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class SetBusinessSystemUserRequest : Microsoft.Xrm.Sdk.OrganizationRequest

[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type SetBusinessSystemUserRequest = class
    inherit OrganizationRequest

Public NotInheritable Class SetBusinessSystemUserRequest
Inherits OrganizationRequest

Inheritance: Object

OrganizationRequest
SetBusinessSystemUserRequest

Attributes: DataContractAttribute

Remarks

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(OrganizationRequest) 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.

Constructors

SetBusinessSystemUserRequest()

Initializes a new instance of the SetBusinessSystemUserRequest class.

Properties

BusinessId	Gets or sets the ID of the business unit to which the user is moved. Required.
DoNotMoveAllRecords
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.

Applies to