Share via

Get-PAMRoleForRequest

Module:
MIMPAM Module

Retrieves PAM roles from the MIM Service.

Syntax

FilterSet (Default) 

Get-PAMRoleForRequest
    [[-Filter] <String>]
    [-Active]
    [<CommonParameters>]

DisplayNameSet 

Get-PAMRoleForRequest
    [[-DisplayName] <String>]
    [-Active]
    [<CommonParameters>]

Description

This cmdlet returns the PAM role resources from the MIM Service, which the user is authorized to request activation.

Examples

EXAMPLE 1

Get-PAMRoleForRequest

This command displays all available roles a user can request.

EXAMPLE 2

$r = Get-PAMRoleForRequest | ? { $_.DisplayName -eq "CorpAdmins" }

This command returns the list of roles and selects a role with a particular name. The result can then be provided to the New-PAMRequest cmdlet.

EXAMPLE 3

Get-PAMRoleForRequest -displayname "CorpAdmins"

This command returns the role with the display name specified.

Parameters

-Active

Only returns roles for which the user has an active request.

Parameter properties

Type:SwitchParameter
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

-DisplayName

Specifies the display name of the role that will be requested.

Parameter properties

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

Parameter sets

DisplayNameSet
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Filter

Specifies a clause to use in the filter when searching in the MIM Service.

Parameter properties

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

Parameter sets

FilterSet
Position:1
Mandatory:False
Value from pipeline:False
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.PAMRoleForRequest

Zero or more matching PAMRoleForRequest objects.