Applies to: Exchange Server 2013, Exchange Online
Topic Last Modified: 2012-08-09
Use the Remove-MailboxPermission cmdlet to remove permissions from a user's mailbox.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Remove-MailboxPermission -AccessRights
<MailboxRights[]> -Identity <MailboxIdParameter> -User
<SecurityPrincipalIdParameter> [-Deny
<SwitchParameter>] [-InheritanceType <None | All |
Descendents | SelfAndChildren | Children>] <COMMON
PARAMETERS>
|
Remove-MailboxPermission -Instance
<MailboxAcePresentationObject> [-AccessRights
<MailboxRights[]>] [-Deny <SwitchParameter>] [-Identity
<MailboxIdParameter>] [-InheritanceType <None | All |
Descendents | SelfAndChildren | Children>] [-User
<SecurityPrincipalIdParameter>] <COMMON
PARAMETERS>
|
Remove-MailboxPermission -Identity
<MailboxIdParameter> <COMMON PARAMETERS>
|
COMMON PARAMETERS: [-Confirm [<SwitchParameter>]]
[-DomainController <Fqdn>] [-IgnoreDefaultScope
<SwitchParameter>] [-WhatIf [<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example removes user Test2's full access rights to Test1's mailbox.
Copy Code | |
---|---|
Remove-MailboxPermission -Identity Test1 -User Test2 -AccessRights FullAccess -InheritanceType All |
Detailed Description
The Remove-MailboxPermission cmdlet allows you to remove permissions from a user's mailbox, for example, removing full access to another user's mailbox.
You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Permissions and delegation" entry in the Recipients Permissions topic.
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
AccessRights |
Required |
Microsoft.Exchange.Management.RecipientTasks.MailboxRights[] |
The AccessRights parameter specifies the rights required to perform the operation. You can use the following values:
|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter |
The Identity parameter identifies the mailbox. You can use the following values:
|
Instance |
Required |
Microsoft.Exchange.Management.RecipientTasks.MailboxAcePresentationObject |
The Instance parameter enables you to pass an entire object to the command to be processed. It's mainly used in scripts where an entire object must be passed to the command. |
User |
Required |
Microsoft.Exchange.Configuration.Tasks.SecurityPrincipalIdParameter |
The User parameter specifies the user mailbox that will get permissions removed. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch. |
Deny |
Optional |
System.Management.Automation.SwitchParameter |
The Deny parameter denies permissions to the user on the Active Directory object. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. |
IgnoreDefaultScope |
Optional |
System.Management.Automation.SwitchParameter |
The IgnoreDefaultScope parameter instructs the command to ignore the default recipient scope setting for the Exchange Management Shell session and use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently in the default scope. Using the IgnoreDefaultScope parameter introduces the following restrictions:
|
InheritanceType |
Optional |
System.DirectoryServices.ActiveDirectorySecurityInheritance |
The InheritanceType parameter specifies whether permissions are inherited to folders within the mailbox. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch. |
Input Types
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.
Return Types
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.