For the complete documentation index, see llms.txt. This page is also available as Markdown.

Update User

Update user metadata and memberships

Description

Updates user profile properties in Microsoft Entra ID and applies optional group memberships and Exchange Online settings. This runbook is typically used to finalize onboarding or to correct user metadata.

Location

User → Userinfo → Update User

Full Runbook name

rjgit-user_userinfo_update-user

Details

Property
Value

Version

1.0.2

Required modules

RealmJoin.RunbookHelper (>= 0.8.9) ExchangeOnlineManagement (>= 3.9.2)

Schedulable

no

Permissions

Application permissions

  • Type: Microsoft Graph

    • UserAuthenticationMethod.Read.All

      • Reads the user's registered MFA methods to skip the password reset if MFA exists

  • Type: Office 365 Exchange Online

    • Exchange.ManageAsApp

      • Opens the app-only Exchange Online session used for distribution groups and enabling the online archive

RBAC roles

  • User Administrator

    • Backs the profile updates, password reset, manager assignment and group adds

  • Exchange Administrator

    • Required for the app-only Exchange Online session managing distribution groups and the online archive

Parameters

UserName

User principal name of the target user.

Property
Value

Required

true

Default Value

Type

String

Hidden in portal

yes (preset via runbook customization)

GivenName

Given name to set for the user.

Property
Value

Required

false

Default Value

Type

String

Surname

Surname to set for the user.

Property
Value

Required

false

Default Value

Type

String

DisplayName

Display name to set for the user.

Property
Value

Required

false

Default Value

Type

String

Portal display name

DisplayName

CompanyName

Company name to set for the user.

Property
Value

Required

false

Default Value

Type

String

City

City to set for the user.

Property
Value

Required

false

Default Value

Type

String

Country

Country to set for the user.

Property
Value

Required

false

Default Value

Type

String

JobTitle

Job title to set for the user.

Property
Value

Required

false

Default Value

Type

String

Department

Department to set for the user.

Property
Value

Required

false

Default Value

Type

String

OfficeLocation

Office location to set for the user.

Property
Value

Required

false

Default Value

Type

String

PostalCode

Postal code to set for the user.

Property
Value

Required

false

Default Value

Type

String

PreferredLanguage

Preferred language to set for the user. Examples: "en-US" or "de-DE".

Property
Value

Required

false

Default Value

Type

String

State

State to set for the user.

Property
Value

Required

false

Default Value

Type

String

StreetAddress

Street address to set for the user.

Property
Value

Required

false

Default Value

Type

String

UsageLocation

Usage location to set for the user.

Property
Value

Required

false

Default Value

Type

String

ManagerId

Optional manager user ID to set for the user.

Property
Value

Required

false

Default Value

Type

String

Portal display name

Manager

DefaultLicense

Display name of a license group to assign.

Property
Value

Required

false

Default Value

Type

String

Portal display name

License group to assign

DefaultGroups

Comma-separated list of group display names to assign.

Property
Value

Required

false

Default Value

Type

String

EnableEXOArchive

If set to true, enables the Exchange Online archive mailbox.

Property
Value

Required

false

Default Value

False

Type

Boolean

ResetPassword

If set to true, resets the user's password.

Property
Value

Required

false

Default Value

False

Type

Boolean

Last updated

Was this helpful?