Share via

Get-PAMRoleForRequest

  • Reference
Module:
MIMPAM

Retrieves PAM roles from the MIM Service.

Syntax

Get-PAMRoleForRequest
   [[-Filter] <String>]
   [-Active]
   [<CommonParameters>]
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

Description

This command displays all available roles a user can request.

EXAMPLE 2

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

Description

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"

Description

This command returns the role with the display name specified.

Parameters

-Active

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

Type:SwitchParameter
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisplayName

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

Type:String
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Filter

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

Type:String
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Microsoft.IdentityManagement.PamCmdlets.Model.PAMRoleForRequest

Zero or more matching PAMRoleForRequest objects.