Skip to main content

Identity

Properties

NameTypeDescriptionNotes
IdStringSystem-generated unique ID of the identity[optional] [readonly]
NameStringThe identity's name is equivalent to its Display Name attribute.[required]
CreatedSystem.DateTimeCreation date of the identity[optional] [readonly]
ModifiedSystem.DateTimeLast modification date of the identity[optional] [readonly]
AliasStringThe identity's alternate unique identifier is equivalent to its Account Name on the authoritative source account schema.[optional]
EmailAddressStringThe email address of the identity[optional]
ProcessingStateEnum [ "ERROR", "OK" ]The processing state of the identity[optional]
IdentityStatusEnum [ "UNREGISTERED", "REGISTERED", "PENDING", "WARNING", "DISABLED", "ACTIVE", "DEACTIVATED", "TERMINATED", "ERROR", "LOCKED" ]The identity's status in the system[optional]
ManagerRefIdentityManagerRef[optional]
IsManagerBooleanWhether this identity is a manager of another identity[optional] [default to $false]
LastRefreshSystem.DateTimeThe last time the identity was refreshed by the system[optional]
Attributes[SystemCollectionsHashtable]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0A map with the identity attributes for the identity[optional]
LifecycleStateIdentityLifecycleState[optional]

Examples

  • Prepare the resource
$Identity = Initialize-Identity  -Id 01f04e428c484542a241dc89c303b178 `
-Name Walter White `
-Created 2023-01-03T21:16:22.432Z `
-Modified 2023-01-03T21:16:22.432Z `
-Alias walter.white `
-EmailAddress walter.white@example.com `
-ProcessingState ERROR `
-IdentityStatus LOCKED `
-ManagerRef null `
-IsManager true `
-LastRefresh 2020-11-22T15:42:31.123Z `
-Attributes {"uid":"86754","firstname":"Walter","cloudStatus":"UNREGISTERED","displayName":"Walter White","identificationNumber":"86754","lastSyncDate":1470348809380,"email":"walter.white@example.com","lastname":"White"} `
-LifecycleState null
  • Convert the resource to JSON
$Identity | ConvertTo-JSON

[Back to top]