DuoSecurity Module

<!-- References -->

This module interacts with the Duo APIs.

Instructions

Prerequisites

• PowerShell 7 or later
• Duo MFA license or higher

Module Installation (PowerShell Gallery)

Install-Module DuoSecurity

Supported Duo APIs

• [X] Accounts API
• [X] Admin API
• [X] Auth API

Examples

Accounts API

Import-Module DuoSecurity

# Accounts API Credentials (MSP only)
$Auth = @{
    Type           = 'Accounts'
    IntegrationKey = 'DUO_INTEGRATION_KEY'
    SecretKey      = 'DUO_SECRET_KEY'
    ApiHost        = 'api-xxxxxxxx.duosecurity.com'
}
Set-DuoApiAuth @Auth

# Retrieve list of Duo child accounts
Get-DuoAccounts

# Select account to use for Admin API queries
Select-DuoAccount -Name 'Your child account name'

# Retrieve user list
Get-DuoUsers

Admin API

Import-Module DuoSecurity

# Admin API credentials
$Auth = @{
    Type           = 'Admin'
    IntegrationKey = 'DUO_INTEGRATION_KEY'
    SecretKey      = 'DUO_SECRET_KEY'
    ApiHost        = 'api-xxxxxxxx.duosecurity.com'
}
Set-DuoApiAuth @Auth

# Retrieve user list
Get-DuoUsers

Cmdlet Help

Accounts API

• Get-DuoAccountEdition
• Get-DuoAccounts
• Get-DuoAccountTelephonyCredits
• New-DuoAccount
• Remove-DuoAccount
• Select-DuoAccount
• Set-DuoAccountEdition
• Set-DuoAccountTelephonyCredits

Admin API

• Administrative Units
  • Add-DuoAdminToAdminUnit
  • Add-DuoGroupToAdminUnit
  • Add-DuoIntegrationToAdminUnit
  • Get-DuoAdminUnits
  • New-DuoAdminUnit
  • Remove-DuoAdminFromAdminUnit
  • Remove-DuoGroup
  • Remove-DuoGroupFromAdminUnit
  • Remove-DuoIntegrationFromAdminUnit
  • Update-DuoAdminUnit
• Administrators
  • Clear-DuoAdminInactivity
  • Get-DuoAdminActivations
  • Get-DuoAdminAuthFactors
  • Get-DuoAdminPasswordManagement
  • Get-DuoAdmins
  • New-DuoAdmin
  • New-DuoAdminActivation
  • New-DuoAdminActivationLink
  • Remove-DuoAdmin
  • Remove-DuoAdminActivation
  • Remove-DuoAdminActivationLink
  • Reset-DuoAdminAuthAttempts
  • Send-DuoAdminActivationEmail
  • Set-DuoAdminAuthFactors
  • Sync-DuoAdminFromDirectory
  • Update-DuoAdmin
• Bypass Codes
  • Get-DuoBypassCodes
  • Remove-DuoBypassCode
• Custom Branding
  • Add-DuoCustomBrandingDraftUser
  • Get-DuoCustomBranding
  • Get-DuoCustomMessaging
  • Publish-DuoCustomBranding
  • Remove-DuoCustomBrandingDraftUser
  • Set-DuoCustomBranding
  • Set-DuoCustomMessaging
• Endpoints
  • Get-DuoEndpoints
• Groups
  • Get-DuoGroups
  • Get-DuoGroupUsers
  • New-DuoGroup
  • Remove-DuoGroup
  • Update-DuoGroup
• Info
  • Get-DuoAccountSummary
  • Get-DuoAuthenticationAttempts
  • Get-DuoTelephonyCreditsUsed
  • Get-DuoUserAuthenticationAttempts
• Integrations
  • Get-DuoIntegrations
  • New-DuoIntegration
  • Remove-DuoIntegration
  • Update-DuoIntegration
• Logs
  • Get-DuoActivityLog
  • Get-DuoAdminLog
  • Get-DuoAuthLog
  • Get-DuoOfflineEnrollmentLog
  • Get-DuoTelephonyLog
• Phones
  • Get-DuoPhone
  • New-DuoPhone
  • New-DuoPhoneActivationCode
  • Remove-DuoPhone
  • Send-DuoPhoneActivationSms
  • Send-DuoPhoneInstallationSms
  • Send-DuoPhoneSmsPasscode
  • Update-DuoPhone
• Settings
  • Get-DuoSetting
  • Update-DuoSetting
• Tokens
  • Get-DuoTokens
  • New-DuoToken
  • Remove-DuoToken
  • Sync-DuoToken
• Trust Monitor
  • Get-DuoTrustMonitorEvents
• Users
  • Add-DuoUserPhone
  • Add-DuoUserToGroup
  • Add-DuoUserToken
  • Get-DuoUserBypassCodes
  • Get-DuoUserGroups
  • Get-DuoUserPhones
  • Get-DuoUsers
  • Get-DuoUserTokens
  • Get-DuoUserWebAuthnCredentials
  • New-DuoUser
  • New-DuoUserBypassCodes
  • Register-DuoUser
  • Remove-DuoUser
  • Remove-DuoUserFromGroup
  • Remove-DuoUserPhone
  • Remove-DuoUserToken
  • Sync-DuoUserFromDirectory
  • Update-DuoUser
• WebAuthn
  • Get-DuoWebAuthnCredentials
  • Remove-DuoWebAuthnCredential

Apps

• Authentication Proxy
  • Get-DuoAuthProxyLogs
• Install & Upgrade
  • Get-DuoInstallFileInfo
  • Install-DuoAuthProxy

Auth API

• Get-DuoAuthEnrollmentStatus
• Get-DuoAuthLogo
• Get-DuoAuthStatus
• New-DuoAuthEnrollment
• Send-DuoAuth
• Send-DuoAuthPing
• Send-DuoPreAuth
• Test-DuoAuthApi

Authentication

• Set-DuoApiAuth

Misc

• Get-DuoAccountID
• New-DuoTokenTotpSecret