Set-PAMUser

  • Reference
Module:
MIMPAM

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

Syntax

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

Description

The Set-PAMUser cmdlet updates a PAM user in the MIM Service and PAM domain. The user object in the source domain is not modified.

Examples

EXAMPLE 1

Set-PAMUser -User (Get-PAMUser -PrivDisplayName "contoso.jen") -PrivAccountActive $false

Description

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

Parameters

-PrivAccountActive

Whether the account is active for login in the PAM domain.

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

-PrivAccountName

Account name for the user in the PAM domain.

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

-PrivDescription

Description of the user account in the MIM Service.

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

-PrivDisplayName

Display Name of the user in the MIM service.

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

-PrivPINCode

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

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

-Session

Session with the PAM domain and MIM Service.

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

-SourceAccountName

Overrides the account name of the user in the source domain.

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

-SourceAccountSID

Overrides the security Identifier of the user in the source domain.

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

-SourceDescription

Overrides the description of the user in the source domain.

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

-SourceDisplayName

Overrides the display name of the user in the source domain.

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

-SourceDomain

NetBIOS name of the domain in which the user source account is located.

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

-SourceEmailAddress

Overrides the email address of the user from the source domain.

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

-SourcePhoneNumber

Overrides the telephone number of the user from the source domain.

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

-User

The user object to be updated, returned by Get-PAMUser.

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

Outputs

Microsoft.IdentityManagement.PamCmdlets.Model.PAMUser

Modified PAM user object.