Set-​PA​MUser

Updates a PAM user in the MIM Service and PAM domain.

Syntax

Set-PAMUser
   [-User] <PAMUser>
   [[-SourcePhoneNumber] <String>]
   [[-SourceEmailAddress] <String>]
   [[-PrivPINCode] <String>]
   [[-SourceAccountSID] <String>]
   [[-Session] <PAMSession>]
   [[-PrivAccountActive] <Boolean>]
   [[-PrivDisplayName] <String>]
   [[-SourceDisplayName] <String>]
   [[-PrivDescription] <String>]
   [[-SourceDescription] <String>]
   [[-SourceDomain] <String>]
   [[-SourceAccountName] <String>]
   [[-PrivAccountName] <String>]
   [<CommonParameters>]

Description

The Set-PAMUser cmdlet updates a Privileged Access Management (PAM) user in the Microsoft Identity Manager (MIM) Service and PAM domain. The user object in other existing domains is not modified.

Examples

Example 1: Deactivate a user in the PAM domain

PS C:\> Set-PAMUser -User (Get-PAMUser -PrivDisplayName "contoso.jen") -PrivAccountActive $False

This command changes an attribute of the user with a specified display name in the MIM Service and the PAM domain.

Required Parameters

-User

Specifies the user object to be updated, the cmdlet returns the object through the Get-PAMUser cmdlet.

Type:PAMUser
Position:1
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Optional Parameters

-PrivAccountActive

Specifies whether the account is active for login in the PAM domain.

Type:Boolean
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PrivAccountName

Specifies the account name for the user in the PAM domain.

Type:String
Position:9
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PrivDescription

Specifies the description of the user account in the MIM Service.

Type:String
Position:5
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PrivDisplayName

Specifies the display name of the user in the MIM Service.

Type:String
Position:3
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PrivPINCode

Specifies the PIN code if the user is required to complete an MFA challenge during activation requests.

Type:String
Position:12
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Session

Specifies the session with the PAM domain and MIM Service.

Type:PAMSession
Position:14
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SourceAccountName

Specifies that the cmdlet overrides the account name of the user in the source domain.

Type:String
Position:8
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SourceAccountSID

Specifies that the cmdlet overrides the security identifier of the user in the source domain.

Type:String
Position:13
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SourceDescription

Specifies that the cmdlet overrides the description of the user in the source domain.

Type:String
Position:6
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SourceDisplayName

Specifies that the cmdlet overrides the display name of the user in the source domain.

Type:String
Position:4
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SourceDomain

Specifies the NetBIOS name of the domain that the user's non-privileged account is located.

Type:String
Position:7
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SourceEmailAddress

Specifies that the cmdlet overrides the email address of the user from the source domain.

Type:String
Position:11
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SourcePhoneNumber

Specifies that the cmdlet overrides the telephone number of the user from the source domain.

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

Outputs

Microsoft.IdentityManagement.PamCmdlets.Model.PAMUser