Remove-VmsRoleClaim¶
SYNOPSIS¶
Removes one or more claims from the specified role.
SYNTAX¶
Remove-VmsRoleClaim [-Role] <Role[]> [[-LoginProvider] <LoginProvider>] [-ClaimName] <String[]>
[-ClaimValue <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION¶
The Remove-VmsRoleClaim cmdlet removes the specified claim(s) from the specified
role(s). The claims must be identified by name and the Get-VmsRoleClaim cmdlet
can be used to retrieve a list of claims and values assigned to the role.
REQUIREMENTS
- Requires VMS connection and will attempt to connect automatically
- Requires VMS version 22.1
EXAMPLES¶
Example 1¶
Removes the claim named 'vms_role' from all roles where it has been added. The
-ErrorAction SilentlyContinue will suppress errors where that claim is not found
on the role.
PARAMETERS¶
-ClaimName¶
Specifies one or more literal claim names to be removed.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ClaimValue¶
Specifies the claim value for claims that should be removed by this command.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-LoginProvider¶
Specifies the login provider associated with the claims to be removed from the role. Current VMS versions support only one external login provider, but future versions may support more than one.
Type: LoginProvider
Parameter Sets: (All)
Aliases: ClaimProvider
Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Role¶
Specifies the role from which to remove the claim(s).
Type: Role[]
Parameter Sets: (All)
Aliases: RoleName
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf¶
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
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.