Skip to content

Latest commit

 

History

History
131 lines (100 loc) · 2.94 KB

Send-DuoPreAuth.md

File metadata and controls

131 lines (100 loc) · 2.94 KB
external help file Module Name online version schema
DuoSecurity-help.xml
DuoSecurity
2.0.0

Send-DuoPreAuth

SYNOPSIS

Duo Pre-Auth

SYNTAX

Username (Default)

Send-DuoPreAuth -Username <String> [-IpAddr <String>] [-Hostname <String>] [-TrustedDeviceToken <String>]
 [<CommonParameters>]

UserId

Send-DuoPreAuth -UserId <String> [-IpAddr <String>] [-Hostname <String>] [-TrustedDeviceToken <String>]
 [<CommonParameters>]

DESCRIPTION

The /preauth endpoint determines whether a user is authorized to log in, and (if so) returns the user's available authentication factors.

EXAMPLES

EXAMPLE 1

Send-DuoPreAuth -Username pgibbons

PARAMETERS

-UserId

Permanent, unique identifier for the user as generated by Duo upon user creation (e.g. DUYHV6TJBC3O4RITS1WC).

Type: String
Parameter Sets: UserId
Aliases: user_id

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

-Username

Unique identifier for the user that is commonly specified by your application during user creation (e.g. [email protected]). This value may also represent a username alias assigned to a user

Type: String
Parameter Sets: Username
Aliases:

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

-IpAddr

The IP address of the user to be authenticated, in dotted quad format. This will cause an "allow" response to be sent if appropriate for requests from a trusted network.

Type: String
Parameter Sets: (All)
Aliases:

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

-Hostname

The host name of the device accessing the application.

Type: String
Parameter Sets: (All)
Aliases:

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

-TrustedDeviceToken

If the trusted_device_token is present and the Auth API application has an effective policy that enables Remembered Devices for each browser-based application, return an "allow" response for the lifetime of the token as set by the Duo administrator in the policy.

Type: String
Parameter Sets: (All)
Aliases:

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

Exactly one of user_id or username must be specified.

RELATED LINKS

https://duo.com/docs/authapi#/preauth