Skip to content

New-DuoIntegration

SYNOPSIS

Create a new integration. The new integration key and secret key are randomly generated and returned in the response

SYNTAX

New-DuoIntegration [-ApiHostname] <String> [-Credential] <PSCredential> [-Name] <String> [-Type] <String>
 [-AllowAllAdminMethods] [-AllowAccountInfo] [-AllowAllAdminIntegrations] [-AllowAllAdminLogs]
 [-AllowAllAdminResources] [-AllowAllAdminSettings] [-AllowAllAdminWriteResources]
 [[-PhoneCallGreeting] <String>] [[-AllowedGrops] <Array>] [[-AllowNetworks] <Array>] [[-Notes] <String>]
 [-AllowSelfService] [[-UsernameNormalization] <String>] [[-AccountId] <String>]
 [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Create a new integration. The new integration key and secret key are randomly generated and returned in the response

EXAMPLES

EXAMPLE 1

$Credential = $(Get-SecureCredential -Name 'DUO_Account' -VaultName 'vault')
PS>$ApiHostname = "api-XXXXXXXX.duosecurity.com"
PS>New-DuoIntegration -Name "My Domain rdp" -Type "rdp" -ApiHostname $ApiHostname -Credential $Credential -AllowSelfService

EXAMPLE 2

$Credential = $(Get-SecureCredential -Name 'DUO_Account' -VaultName 'vault')
PS>$ApiHostname = "api-XXXXXXXX.duosecurity.com"
PS>New-DuoIntegration -Name "My Domain owa" -Type "owa" -ApiHostname $ApiHostname -Credential $Credential

PARAMETERS

-ApiHostname

Target API hostname E.g. api-XXXXXXXX.duosecurity.com

Type: String
Parameter Sets: (All)
Aliases:

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

-Credential

PSCredential containing IKEY as Name and SKEY as securestring

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-Name

The name of the integration to create

Type: String
Parameter Sets: (All)
Aliases:

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

-Type

The type of integration to create Allowed values: "1password","accountsapi","adfs","adminapi","aeries","agadobe_documentcloud","agaha","agasana","agaws","agatlassian-cloud","agbamboohr","agbarracuda-waf","agbluejeans","agbomgar","agbonusly","agbox","agbugsnag","agcanvas","agciscoasa","agclarizen","agcloudlock","agconfluence","agcrashplan","agcyberark","agdatadog","agdesk","agdigicert","agdng","agdocusign","agdropbox","agduo-adminpanel","agegnyte","agevernote","agexpensify","agfacebook","agfreshdesk","aggeneric","aggithub-business","aggithub-enterprise","aggoogle","aggotomeeting","aggreenhouse","aghackerone","aghackerrank","agheroku","aghipchat","agigloo","agintacct","agjamf-jss","agjira","agjitbit","aglooker","agmarketo","agmeraki","agmonday","agnamely","agnetdocuments","agnewrelic","agoffice365","agopendns","agpagerduty","agpaloalto-aperture","agpaloalto","agremedyforce","agringcentral","agrobin","agsalesforce","agsamanage","agsaucelabs","agsharefile","agsignalsciences","agslack","agsmartsheet","agstatuspageio","agsugarcrm","agsumologic","agsyncplicity","agtableau-online","agtableau","agudemy","aguservoice","agwebex","agwebex-controlhub","agworkday","agzendesk","agzoom","akamai-eaa","array","aws-directory-service","azure-ca","authapi","barracuda","bitium","bitwarden","bomgar","caradigm","cas","checkpoint","cisco","ciscofirepower","ciscoiseradius","ciscoradius","citrixcag","citrixns","clearpass","confluence","cyberark","cyberarkweb","dag","device","device-management-portal","dng","dng-rdp","dng-smb","dng-ssh","drawbridgenetworks","drupal","epic","f5bigip","f5bigipweb","f5firepass","fortinet","greyheller","huntress","jira","juniper","juniperuac","keeper","labtech","lastpass","ldapproxy","macos","merakiradius","myworkdrive","netmotion","oam","okta","onelogin","openvpn","openvpnas","owa","paloalto","partner_authapi","partner_websdk","pingfederate","portal","radius","rdgateway","rdp","rdweb","resilient","rest","rras","sailpoint","sailpointweb","samlidp","shibboleth","securex-dashboard","sonicwallsra","sophosutm","splunk","thycotic","tmg","uag","unix","verify","vmwareview","websdk","workday","wordpress"

Type: String
Parameter Sets: (All)
Aliases:

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

-AllowAllAdminMethods

Grant an Admin API integration permission for all Admins methods

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-AllowAccountInfo

If creating an Admin API integration, set this to grant it permission for all Account Info methods

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-AllowAllAdminIntegrations

Grant an Admin API integration permission for all Integrations methods

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-AllowAllAdminLogs

Grant an Admin API integration permission for all Logs methods

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-AllowAllAdminResources

Grant an Admin API integration permission to retrieve objects like users, phones, and hardware tokens

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-AllowAllAdminSettings

Grant an Admin API integration permission for all Settings methods

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-AllowAllAdminWriteResources

Grant an Admin API integration permission to create and modify objects like users, phones, and hardware tokens.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-PhoneCallGreeting

Voice greeting read before the authentication instructions to users who authenticate with a phone callback

Type: String
Parameter Sets: (All)
Aliases:

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

-AllowedGrops

An array of group IDs that are allowed to authenticate with the integration. If empty, all interations are allowed. Object limits: 100 interations per integration.

Type: Array
Parameter Sets: (All)
Aliases:

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

-AllowNetworks

An array of IP addresses, IP ranges, or CIDRs specifying the networks allowed to access this API integration. Only applicable to Accounts API and Admin API integrations. A given API integration may apply a network restriction to itself via API; use a different API integration to apply the network restriction, or edit the API application in the Duo Admin Panel GUI.

Type: Array
Parameter Sets: (All)
Aliases:

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

-Notes

Description of the integration

Type: String
Parameter Sets: (All)
Aliases:

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

-AllowSelfService

Grant an integration permission to allow users to manage their own devices. This is only supported by integrations which allow for self service configuration

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-UsernameNormalization

Policy for whether or not usernames should be altered before trying to match them to a user account.

Type: String
Parameter Sets: (All)
Aliases:

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

-AccountId

Target Account Id

Type: String
Parameter Sets: (All)
Aliases:

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

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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