Share via

New-PAMRequest

Module:
MIMPAM Module

Creates a PAM activation request in the MIM Service.

Syntax

Role as PAMRole 

New-PAMRequest
    [[-Role] <PAMRoleForRequest>]
    [[-Justification] <String>]
    [[-RequestedTTL] <TimeSpan>]
    [-RequestedTime <DateTime>]
    [<CommonParameters>]

Role as Display Name 

New-PAMRequest
    [[-RoleDisplayName] <String>]
    [[-Justification] <String>]
    [[-RequestedTTL] <TimeSpan>]
    [-RequestedTime <DateTime>]
    [<CommonParameters>]

Description

This cmdlet creates a new PAM activation request in the MIM Service. A role must be specified, using either the Role or RoleDisplayName parameters, which indicates the security groups to which the user is requesting to be added.

Examples

EXAMPLE 1

$s = New-PAMRequest -role $r

This command creates a new request for a PAM Role. The variable r is assumed to have been set by a previous use of the cmdlet Get-PAMRoleForRequest.

Parameters

-Justification

An optional text parameter to be included in the activation request.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RequestedTime

Optional delayed start time for the activation.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RequestedTTL

An optional override of the time to live for the activation request once started. If not specified, then the role default TTL is used instead.

Parameter properties

Type:TimeSpan
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:3
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Role

The PAM role in MIM Service being requested, returned by Get-PAMRoleForRequest.

Parameter properties

Type:PAMRoleForRequest
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Role as PAMRole
Position:1
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-RoleDisplayName

The display name of PAM role in the MIM Service being requested.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Role as Display Name
Position:1
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

Microsoft.IdentityManagement.PamCmdlets.Model.PAMRequest

The newly created PAMRequest object.