Skip to content

Remove-TeamViewerRole.md

Latest commit

 

History

History
132 lines (91 loc) · 2.5 KB

Remove-TeamViewerRole.md

File metadata and controls

132 lines (91 loc) · 2.5 KB
Raw

external help file: TeamViewerPS-help.xml Module Name: TeamViewerPS online version: https://github.com/teamviewer/TeamViewerPS/blob/main/Docs/Help/Remove-TeamViewerRole.md schema: 2.0.0

Remove-TeamViewerRole

SYNOPSIS

Deletes one specific role from the TeamViewer company.

SYNTAX

Remove-TeamViewerRole [-APIToken] <SecureString> [-RoleId] <Object> [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Deletes one specific role from the TeamViewer company. All permissions and user assignments of the role will be deleted too.

EXAMPLES

Example 1

Remove-TeamViewerRole -RoleId '9b465ea2-2f75-4101-a057-58a81ed0e57b'

Deletes the role with Id 9b465ea2-2f75-4101-a057-58a81ed0e57b.

Example 2

 Remove-TeamViewerRole -RoleId (Get-TeamViewerRole | Where-Object { ($_.RoleName -eq 'Test Role') } ).RoleID

Deletes a role with the role Id retrieved from Get-TeamViewerRole as input. In this example, the role with the name Test Role.

Example 3

Remove-TeamViewerRole -Id 'c0cb303a-8a85-4e54-b657-a4757c791aef'

Deletes the role with the given Id, using the Id alias.

PARAMETERS

-APIToken

The TeamViewer API access token.

Type: SecureString
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
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: None
Accept pipeline input: False
Accept wildcard characters: False

-RoleId

The role to be deleted.

Type: Object
Parameter Sets: (All)
Aliases: Id, Role

Required: True
Position: 1
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.

INPUTS

None

OUTPUTS

NOTES

RELATED LINKS