Skip to content

Latest commit

 

History

History
290 lines (213 loc) · 8.22 KB

Remove-CMSecurityRoleFromAdministrativeUser.md

File metadata and controls

290 lines (213 loc) · 8.22 KB
external help file Module Name ms.date schema title
AdminUI.PS.dll-Help.xml
ConfigurationManager
12/21/2021
2.0.0
Remove-CMSecurityRoleFromAdministrativeUser

Remove-CMSecurityRoleFromAdministrativeUser

SYNOPSIS

Remove the association between a security role and an administrative user.

SYNTAX

RemoveRoleFromAdminByName_Name (Default)

Remove-CMSecurityRoleFromAdministrativeUser -AdministrativeUserName <String> [-Force] -RoleName <String>
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

RemoveRoleFromAdminById_Object

Remove-CMSecurityRoleFromAdministrativeUser -AdministrativeUser <IResultObject> [-Force] -RoleId <String>
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

RemoveRoleFromAdminByName_Object

Remove-CMSecurityRoleFromAdministrativeUser -AdministrativeUser <IResultObject> [-Force] -RoleName <String>
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

RemoveRoleFromAdminByObject_Object

Remove-CMSecurityRoleFromAdministrativeUser -AdministrativeUser <IResultObject> [-Force] -Role <IResultObject>
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

RemoveRoleFromAdminById_Id

Remove-CMSecurityRoleFromAdministrativeUser -AdministrativeUserId <Int32> [-Force] -RoleId <String>
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

RemoveRoleFromAdminByName_Id

Remove-CMSecurityRoleFromAdministrativeUser -AdministrativeUserId <Int32> [-Force] -RoleName <String>
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

RemoveRoleFromAdminByObject_Id

Remove-CMSecurityRoleFromAdministrativeUser -AdministrativeUserId <Int32> [-Force] -Role <IResultObject>
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

RemoveRoleFromAdminById_Name

Remove-CMSecurityRoleFromAdministrativeUser -AdministrativeUserName <String> [-Force] -RoleId <String>
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

RemoveRoleFromAdminByObject_Name

Remove-CMSecurityRoleFromAdministrativeUser -AdministrativeUserName <String> [-Force] -Role <IResultObject>
 [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Use this cmdlet to remove the association between one or more security roles and an administrative user. After you remove the association of a security role with an administrative user, the administrative user can't view the objects in Configuration Manager that are associated with the security role. They also no longer have the permission to do the tasks that are related to those objects.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

EXAMPLES

Example 1: Remove a security role from an administrative user

This command removes the association between the security role named Security Update Manager and the administrative user named Contoso\PattiFuller. Since it specifies the Force parameter, it runs without prompting.

Remove-CMSecurityRoleFromAdministrativeUser -AdministrativeUserName "Contoso\PattiFuller" -RoleName "Security Update Manager" -Force

PARAMETERS

-AdministrativeUser

Specify an administrative user object to configure. To get this object, use the Get-CMAdministrativeUser cmdlet.

Type: IResultObject
Parameter Sets: RemoveRoleFromAdminById_Object, RemoveRoleFromAdminByName_Object, RemoveRoleFromAdminByObject_Object
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-AdministrativeUserId

Specify the ID of the administrative user to configure. This value is the AdminID property, which is an integer value. For example, 16777234.

Type: Int32
Parameter Sets: RemoveRoleFromAdminById_Id, RemoveRoleFromAdminByName_Id, RemoveRoleFromAdminByObject_Id
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AdministrativeUserName

Specify the name of the administrative user to configure.

Type: String
Parameter Sets: RemoveRoleFromAdminByName_Name, RemoveRoleFromAdminById_Name, RemoveRoleFromAdminByObject_Name
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Force

Forces the command to run without asking for user confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Role

Specify a security role object to remove. To get this object, use the Get-CMSecurityRole cmdlet.

Type: IResultObject
Parameter Sets: RemoveRoleFromAdminByObject_Object, RemoveRoleFromAdminByObject_Id, RemoveRoleFromAdminByObject_Name
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-RoleId

Specify the ID of the security role to remove. This value is the RoleID property, for example SMS000AR for the OS Deployment Manager role.

Type: String
Parameter Sets: RemoveRoleFromAdminById_Object, RemoveRoleFromAdminById_Id, RemoveRoleFromAdminById_Name
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RoleName

Specify the name of the security role to remove.

Type: String
Parameter Sets: RemoveRoleFromAdminByName_Name, RemoveRoleFromAdminByName_Object, RemoveRoleFromAdminByName_Id
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

OUTPUTS

System.Object

NOTES

RELATED LINKS

Add-CMSecurityRoleToAdministrativeUser

Remove-CMSecurityScopeFromAdministrativeUser

Get-CMAdministrativeUser

Get-CMSecurityRole

Automate role-based administration with Windows PowerShell