Skip to content

Latest commit

 

History

History
108 lines (81 loc) · 2.5 KB

Remove-DuoAdminFromAdminUnit.md

File metadata and controls

108 lines (81 loc) · 2.5 KB
external help file Module Name online version schema
DuoSecurity-help.xml
DuoSecurity
2.0.0

Remove-DuoAdminFromAdminUnit

SYNOPSIS

Remove Administrator from Administrative Unit

SYNTAX

Remove-DuoAdminFromAdminUnit [-AdminUnitId] <String> [-AdminId] <String> [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Unassign the administrator with admin_id from the administrative unit with admin_unit_id. The administrator user will still have restricted_by_admin_units set to true, and if the admin is not assigned to any other admin unit they will not be able to view any users or integrations. Be sure to change the value of restricted_by_admin_units to false to permit that admin to view all users and integrations. Requires "Grant administrators" API permission.

EXAMPLES

EXAMPLE 1

Remove-DuoAdminFromAdminUnit -AdminUnitId SOMEADMINUNITID -AdminId SOMEADMINID

PARAMETERS

-AdminUnitId

The ID of the Administrative Unit

Type: String
Parameter Sets: (All)
Aliases: admin_unit_id

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-AdminId

The ID of the Administrator

Type: String
Parameter Sets: (All)
Aliases: admin_id

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
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

-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

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

OUTPUTS

NOTES

RELATED LINKS

https://duo.com/docs/adminapi#remove-administrator-from-administrative-unit