Update-MgBetaDirectoryExternalUserProfile

Module:

Microsoft.Graph.Beta.Identity.DirectoryManagement

Update the properties of a externalUserProfile object.

Syntax

Update-MgBetaDirectoryExternalUserProfile
      -ExternalUserProfileId <String>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-Address <IMicrosoftGraphPhysicalOfficeAddress>]
      [-CompanyName <String>]
      [-CreatedBy <String>]
      [-CreatedDateTime <DateTime>]
      [-DeletedDateTime <DateTime>]
      [-Department <String>]
      [-DisplayName <String>]
      [-Id <String>]
      [-IsDiscoverable]
      [-IsEnabled]
      [-JobTitle <String>]
      [-PhoneNumber <String>]
      [-SupervisorId <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-MgBetaDirectoryExternalUserProfile
      -ExternalUserProfileId <String>
      -BodyParameter <Hashtable>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-MgBetaDirectoryExternalUserProfile
      -InputObject <IIdentityDirectoryManagementIdentity>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-Address <IMicrosoftGraphPhysicalOfficeAddress>]
      [-CompanyName <String>]
      [-CreatedBy <String>]
      [-CreatedDateTime <DateTime>]
      [-DeletedDateTime <DateTime>]
      [-Department <String>]
      [-DisplayName <String>]
      [-Id <String>]
      [-IsDiscoverable]
      [-IsEnabled]
      [-JobTitle <String>]
      [-PhoneNumber <String>]
      [-SupervisorId <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-MgBetaDirectoryExternalUserProfile
      -InputObject <IIdentityDirectoryManagementIdentity>
      -BodyParameter <Hashtable>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Update the properties of a externalUserProfile object.

Permissions

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	ExternalUserProfile.ReadWrite.All	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	ExternalUserProfile.ReadWrite.All	Not available.

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement

$params = @{
	jobTitle = "Contractor"
}

Update-MgBetaDirectoryExternalUserProfile -ExternalUserProfileId $externalUserProfileId -BodyParameter $params

This example shows how to use the Update-MgBetaDirectoryExternalUserProfile Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Address

physicalOfficeAddress To construct, see NOTES section for ADDRESS properties and create a hash table.

Type:	IMicrosoftGraphPhysicalOfficeAddress
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BodyParameter

externalUserProfile

Type:	Hashtable
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-CompanyName

The company name of the external user profile. Supports $filter (eq, startswith).

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CreatedBy

The object ID of the user who created the external user profile. Read-only. Not nullable.

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

-CreatedDateTime

Date and time when this external user was created. Not nullable. Read-only.

Type:	DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DeletedDateTime

Date and time when this object was deleted. Always null when the object hasn't been deleted.

Type:	DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Department

The department of the external user profile.

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

-DisplayName

The display name of the external user profile.

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

-ExternalUserProfileId

The unique identifier of externalUserProfile

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

-Headers

Optional headers that will be added to the request.

Type:	IDictionary
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Id

The unique identifier for an entity. Read-only.

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

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	IIdentityDirectoryManagementIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-IsDiscoverable

Represents whether the external user profile is discoverable in the directory. When true, this external profile shows up in Teams search.

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

-IsEnabled

Represents whether the external user profile is enabled in the directory. This property is peer to the accountEnabled property on the user object.

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

-JobTitle

The job title of the external user profile.

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

-PhoneNumber

The phone number of the external user profile. Must be in E164 format.

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

-ProgressAction

{{ Fill ProgressAction Description }}

Type:	ActionPreference
Aliases:	proga
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type:	String
Aliases:	RHV
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SupervisorId

The object ID of the supervisor of the external user profile. Supports $filter (eq, startswith).

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IIdentityDirectoryManagementIdentity

System.Collections.Hashtable

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphExternalUserProfile

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

ADDRESS <IMicrosoftGraphPhysicalOfficeAddress>: physicalOfficeAddress

• [(Any) <Object>]: This indicates any property can be added to this object.
• [City <String>]: The city.
• [CountryOrRegion <String>]: The country or region. It's a free-format string value, for example, 'United States'.
• [OfficeLocation <String>]: Office location such as building and office number for an organizational contact.
• [PostalCode <String>]: The postal code.
• [State <String>]: The state.
• [Street <String>]: The street.

INPUTOBJECT <IIdentityDirectoryManagementIdentity>: Identity Parameter

• [AdministrativeUnitId <String>]: The unique identifier of administrativeUnit
• [AllowedValueId <String>]: The unique identifier of allowedValue
• [AttributeSetId <String>]: The unique identifier of attributeSet
• [CertificateAuthorityAsEntityId <String>]: The unique identifier of certificateAuthorityAsEntity
• [CertificateBasedApplicationConfigurationId <String>]: The unique identifier of certificateBasedApplicationConfiguration
• [CommandId <String>]: The unique identifier of command
• [CommerceSubscriptionId <String>]: Alternate key of companySubscription
• [CompanySubscriptionId <String>]: The unique identifier of companySubscription
• [ContractId <String>]: The unique identifier of contract
• [CustomSecurityAttributeDefinitionId <String>]: The unique identifier of customSecurityAttributeDefinition
• [DeviceId <String>]: The unique identifier of device
• [DeviceLocalCredentialInfoId <String>]: The unique identifier of deviceLocalCredentialInfo
• [DirectoryObjectId <String>]: The unique identifier of directoryObject
• [DirectoryRoleId <String>]: The unique identifier of directoryRole
• [DirectoryRoleTemplateId <String>]: The unique identifier of directoryRoleTemplate
• [DirectorySettingId <String>]: The unique identifier of directorySetting
• [DirectorySettingTemplateId <String>]: The unique identifier of directorySettingTemplate
• [DomainDnsRecordId <String>]: The unique identifier of domainDnsRecord
• [DomainId <String>]: The unique identifier of domain
• [ExtensionId <String>]: The unique identifier of extension
• [ExternalUserProfileId <String>]: The unique identifier of externalUserProfile
• [FeatureRolloutPolicyId <String>]: The unique identifier of featureRolloutPolicy
• [IdentityProviderBaseId <String>]: The unique identifier of identityProviderBase
• [ImpactedResourceId <String>]: The unique identifier of impactedResource
• [InboundSharedUserProfileUserId <String>]: The unique identifier of inboundSharedUserProfile
• [InternalDomainFederationId <String>]: The unique identifier of internalDomainFederation
• [ManagedTenantAlertId <String>]: The unique identifier of managedTenantAlert
• [ManagementActionId <String>]: The unique identifier of managementAction
• [OcpSubscriptionId <String>]: Alternate key of companySubscription
• [OnPremisesDirectorySynchronizationId <String>]: The unique identifier of onPremisesDirectorySynchronization
• [OrgContactId <String>]: The unique identifier of orgContact
• [OrganizationId <String>]: The unique identifier of organization
• [OrganizationalBrandingLocalizationId <String>]: The unique identifier of organizationalBrandingLocalization
• [OutboundSharedUserProfileUserId <String>]: The unique identifier of outboundSharedUserProfile
• [PendingExternalUserProfileId <String>]: The unique identifier of pendingExternalUserProfile
• [ProfileCardPropertyId <String>]: The unique identifier of profileCardProperty
• [RecommendationId <String>]: The unique identifier of recommendation
• [RoleTemplateId <String>]: Alternate key of directoryRole
• [ScopedRoleMembershipId <String>]: The unique identifier of scopedRoleMembership
• [SharedEmailDomainId <String>]: The unique identifier of sharedEmailDomain
• [SharedEmailDomainInvitationId <String>]: The unique identifier of sharedEmailDomainInvitation
• [SubscribedSkuId <String>]: The unique identifier of subscribedSku
• [TenantId <String>]: The unique identifier of tenant
• [TenantReferenceTenantId <String>]: The unique identifier of tenantReference
• [TenantTagId <String>]: The unique identifier of tenantTag
• [UsageRightId <String>]: The unique identifier of usageRight
• [UserId <String>]: The unique identifier of user

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.beta.identity.directorymanagement/update-mgbetadirectoryexternaluserprofile
• https://learn.microsoft.com/graph/api/externaluserprofile-update?view=graph-rest-beta