Skip to content

Latest commit

 

History

History
201 lines (156 loc) · 4.05 KB

Update-DuoAdminUnit.md

File metadata and controls

201 lines (156 loc) · 4.05 KB
Raw
external help file Module Name online version schema
DuoSecurity-help.xml
DuoSecurity
2.0.0

Update-DuoAdminUnit

SYNOPSIS

Modify Administrative Unit

SYNTAX

Update-DuoAdminUnit [-AdminUnitId] <String> [[-Name] <String>] [[-Description] <String>] [-RestrictByGroups]
 [-RestrictByIntegrations] [[-Admins] <String[]>] [[-Groups] <String[]>] [[-Integrations] <String[]>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

Change the name, description, assigned administrators, groups, and/or integrations of the administrative unit with admin_unit_id. Requires "Grant administrators" API permission.

EXAMPLES

EXAMPLE 1

Update-DuoAdminUnit -AdminUnitId SOMEADMINUNITID -Name 'Accounts Payable Admins' -RestrictByGroups -Groups 'ACCTSPAYABLEGROUPID'

PARAMETERS

-AdminUnitId

The ID of the Administrative Unit

Type: String
Parameter Sets: (All)
Aliases:

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

-Name

The new name of the administrative unit. Must be unique amongst all administrative units.

Type: String
Parameter Sets: (All)
Aliases:

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

-Description

An updated description of the administrative unit.

Type: String
Parameter Sets: (All)
Aliases:

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

-RestrictByGroups

Change whether the administrative unit specifies groups. Default: false.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-RestrictByIntegrations

Change whether the administrative unit specifies integrations. Default: false.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Admins

One or more admin_id values to assign administrators to the new administrative unit. The administrator user must have restricted_by_admin_units set to true before attempting to assign them to an administrative unit via the API.

Type: String[]
Parameter Sets: (All)
Aliases:

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

-Groups

One or more group_id values to assign groups to the new administrative unit.

Type: String[]
Parameter Sets: (All)
Aliases:

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

-Integrations

One or more integration_key values to assign integrations to the new administrative unit.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
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

-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#modify-administrative-unit