Update-AzADUser

使用者中的 更新 實體

Syntax

Update-AzADUser
      -UPNOrObjectId <String>
      [-AccountEnabled <Boolean>]
      [-Password <SecureString>]
      [-ForceChangePasswordNextLogin]
      [-AgeGroup <String>]
      [-City <String>]
      [-CompanyName <String>]
      [-ConsentProvidedForMinor <String>]
      [-Country <String>]
      [-DeletedDateTime <DateTime>]
      [-Department <String>]
      [-DisplayName <String>]
      [-EmployeeHireDate <DateTime>]
      [-EmployeeId <String>]
      [-EmployeeType <String>]
      [-ExternalUserState <String>]
      [-ExternalUserStateChangeDateTime <DateTime>]
      [-FaxNumber <String>]
      [-GivenName <String>]
      [-Id <String>]
      [-Identity <IMicrosoftGraphObjectIdentity[]>]
      [-IsResourceAccount]
      [-JobTitle <String>]
      [-Mail <String>]
      [-MailNickname <String>]
      [-OfficeLocation <String>]
      [-OnPremisesImmutableId <String>]
      [-OtherMail <String[]>]
      [-PasswordPolicy <String>]
      [-PasswordProfile <IMicrosoftGraphPasswordProfile>]
      [-PostalCode <String>]
      [-PreferredLanguage <String>]
      [-ShowInAddressList]
      [-State <String>]
      [-StreetAddress <String>]
      [-Surname <String>]
      [-UsageLocation <String>]
      [-UserType <String>]
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzADUser
      [-AccountEnabled <Boolean>]
      [-Password <SecureString>]
      [-ForceChangePasswordNextLogin]
      [-AgeGroup <String>]
      [-City <String>]
      [-CompanyName <String>]
      [-ConsentProvidedForMinor <String>]
      [-Country <String>]
      [-DeletedDateTime <DateTime>]
      [-Department <String>]
      [-DisplayName <String>]
      [-EmployeeHireDate <DateTime>]
      [-EmployeeId <String>]
      [-EmployeeType <String>]
      [-ExternalUserState <String>]
      [-ExternalUserStateChangeDateTime <DateTime>]
      [-FaxNumber <String>]
      [-GivenName <String>]
      [-Id <String>]
      [-Identity <IMicrosoftGraphObjectIdentity[]>]
      [-IsResourceAccount]
      [-JobTitle <String>]
      [-Mail <String>]
      [-MailNickname <String>]
      [-OfficeLocation <String>]
      [-OnPremisesImmutableId <String>]
      [-OtherMail <String[]>]
      [-PasswordPolicy <String>]
      [-PasswordProfile <IMicrosoftGraphPasswordProfile>]
      [-PostalCode <String>]
      [-PreferredLanguage <String>]
      [-ShowInAddressList]
      [-State <String>]
      [-StreetAddress <String>]
      [-Surname <String>]
      [-UsageLocation <String>]
      [-UserType <String>]
      -ObjectId <String>
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzADUser
      [-AccountEnabled <Boolean>]
      [-Password <SecureString>]
      [-ForceChangePasswordNextLogin]
      [-AgeGroup <String>]
      [-City <String>]
      [-CompanyName <String>]
      [-ConsentProvidedForMinor <String>]
      [-Country <String>]
      [-DeletedDateTime <DateTime>]
      [-Department <String>]
      [-DisplayName <String>]
      [-EmployeeHireDate <DateTime>]
      [-EmployeeId <String>]
      [-EmployeeType <String>]
      [-ExternalUserState <String>]
      [-ExternalUserStateChangeDateTime <DateTime>]
      [-FaxNumber <String>]
      [-GivenName <String>]
      [-Id <String>]
      [-Identity <IMicrosoftGraphObjectIdentity[]>]
      [-IsResourceAccount]
      [-JobTitle <String>]
      [-Mail <String>]
      [-MailNickname <String>]
      [-OfficeLocation <String>]
      [-OnPremisesImmutableId <String>]
      [-OtherMail <String[]>]
      [-PasswordPolicy <String>]
      [-PasswordProfile <IMicrosoftGraphPasswordProfile>]
      [-PostalCode <String>]
      [-PreferredLanguage <String>]
      [-ShowInAddressList]
      [-State <String>]
      [-StreetAddress <String>]
      [-Surname <String>]
      [-UsageLocation <String>]
      [-UserType <String>]
      -InputObject <IMicrosoftGraphUser>
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzADUser
      [-AccountEnabled <Boolean>]
      [-Password <SecureString>]
      [-ForceChangePasswordNextLogin]
      [-AgeGroup <String>]
      [-City <String>]
      [-CompanyName <String>]
      [-ConsentProvidedForMinor <String>]
      [-Country <String>]
      [-DeletedDateTime <DateTime>]
      [-Department <String>]
      [-DisplayName <String>]
      [-EmployeeHireDate <DateTime>]
      [-EmployeeId <String>]
      [-EmployeeType <String>]
      [-ExternalUserState <String>]
      [-ExternalUserStateChangeDateTime <DateTime>]
      [-FaxNumber <String>]
      [-GivenName <String>]
      [-Id <String>]
      [-Identity <IMicrosoftGraphObjectIdentity[]>]
      [-IsResourceAccount]
      [-JobTitle <String>]
      [-Mail <String>]
      [-MailNickname <String>]
      [-OfficeLocation <String>]
      [-OnPremisesImmutableId <String>]
      [-OtherMail <String[]>]
      [-PasswordPolicy <String>]
      [-PasswordProfile <IMicrosoftGraphPasswordProfile>]
      [-PostalCode <String>]
      [-PreferredLanguage <String>]
      [-ShowInAddressList]
      [-State <String>]
      [-StreetAddress <String>]
      [-Surname <String>]
      [-UsageLocation <String>]
      [-UserType <String>]
      -UserPrincipalName <String>
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

使用者中的 更新 實體

範例

範例 1:依用戶主體名稱更新使用者

Update-AzADUser -UPNOrObjectId $upn -City $city

依用戶主體名稱更新使用者

參數

-AccountEnabled

true 表示啟用帳戶;否則為 false。 結合 -Password時一律為 true。 -AccountEnabled $false 變更帳戶的密碼時,會忽略 。

Type:Boolean
Aliases:EnableAccount
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AgeGroup

設定用戶的年齡群組。 允許的值:null、minor、notAdult 和成人。 如需進一步資訊,請參閱法律年齡群組屬性定義。 支援$filter(eq、ne、NOT 和 in)。

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

-City

使用者所在的城市。 長度上限為 128 個字元。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。

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

-CompanyName

使用者相關聯的公司名稱。 此屬性對於描述外部使用者所來自的公司很有用。 公司名稱的最大長度為64個字元。支援$filter(eq、ne、NOT、ge、le、in、startsWith)。

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

-Confirm

執行 Cmdlet 之前先提示您確認。

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

-ConsentProvidedForMinor

設定是否已為未成年人取得同意。 允許的值:Null、授與、拒絕和 notRequired。 如需進一步資訊,請參閱法律年齡群組屬性定義。 支援$filter(eq、ne、NOT 和 in)。

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

-Country

使用者所在的國家/地區;例如,美國或英國。 長度上限為 128 個字元。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。

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

-DefaultProfile

用於與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶。

Type:PSObject
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DeletedDateTime

.

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

-Department

用戶運作所在的部門名稱。 最大長度為64個字元。支援$filter(eq、ne、NOT、ge、le 和 in 運算符)。

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

-DisplayName

使用者通訊錄中顯示的名稱。 此值通常是使用者名字、中間縮寫和姓氏的組合。 建立使用者且無法在更新期間清除時,需要這個屬性。 長度上限為 256 個字元。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)、$orderBy和$search。

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

-EmployeeHireDate

僱用使用者的日期和時間,或將在未來的僱用時開始工作。 支援$filter (eq, ne, NOT , ge, le, in) 。

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

-EmployeeId

由組織指派給使用者的員工標識碼。 支援$filter (eq, ne, NOT , ge, le, in, startsWith) 。

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

-EmployeeType

擷取企業背景工作角色類型。 例如,員工、承包商、顧問或廠商。 支援$filter (eq, ne, NOT , ge, le, in, startsWith) 。

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

-ExternalUserState

對於使用邀請 API 邀請給租使用者的外部使用者,此屬性代表受邀使用者的邀請狀態。 對於受邀的用戶,狀態可以是PendingAcceptance或 Accepted,或所有其他使用者的 Null。 支援 $filter (eq, ne, NOT , in) 。

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

-ExternalUserStateChangeDateTime

顯示 externalUserState 屬性最新變更的時間戳。 支援 $filter (eq, ne, NOT , in) 。

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

-FaxNumber

用戶的傳真編號。 支援$filter (eq, ne, NOT , ge, le, in, startsWith) 。

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

-ForceChangePasswordNextLogin

如果用戶必須在下一次成功登入時變更密碼,則必須指定它 (true)。 默認行為為 [false] ,無法變更下一次成功登入的密碼。

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

-GivenName

使用者的指定名稱(名字)。 最大長度為64個字元。 支援$filter (eq, ne, NOT , ge, le, in, startsWith) 。

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

-Id

唯讀。

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

-Identity

表示可用來登入此用戶帳戶的身分識別。 身分識別可由 Microsoft 提供(也稱為本機帳戶)、組織或社交識別提供者,例如 Facebook、Google 和 Microsoft,以及系結至用戶帳戶。 可能包含多個具有相同 signInType 值的專案。 僅支援 signInType 不是 userPrincipalName 的 $filter (eq)。 若要建構,請參閱 IDENTITY 屬性的 NOTES 一節,並建立哈希表。

Type:IMicrosoftGraphObjectIdentity[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

使用者輸入物件 若要建構,請參閱 INPUTOBJECT 屬性的 NOTES 區段並建立哈希表。

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

-IsResourceAccount

請勿使用 - 保留供日後使用。

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

-JobTitle

用戶的職稱。 長度上限為 128 個字元。 支援$filter (eq, ne, NOT , ge, le, in, startsWith) 。

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

-Mail

使用者的 SMTP 位址, admin@contoso.com 例如 。 此屬性的變更也會更新使用者的 proxyAddresses 集合,以將值納入 SMTP 位址。 雖然這個屬性可以包含輔色字元,但使用這些字元可能會對使用者的其他 Microsoft 應用程式造成存取問題。 支援$filter(eq、ne、NOT、ge、le、in、startsWith、endsWith)。

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

-MailNickname

用戶的郵件別名。 建立使用者時,必須指定這個屬性。 最大長度為64個字元。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。

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

-ObjectId

要更新之用戶的用戶主體名稱。

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

-OfficeLocation

使用者營業地點中的辦公室位置。 長度上限為 128 個字元。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。

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

-OnPremisesImmutableId

這個屬性可用來將 內部部署的 Active Directory 用戶帳戶與其 Microsoft Entra 使用者對象產生關聯。 如果您使用使用者 userPrincipalName (UPN) 屬性的同盟網域,則必須在 Graph 中建立新的使用者帳戶時指定此屬性。 注意:指定這個屬性時,無法使用 $ 和 _ 字元。 只在$select傳回。 支援$filter(eq、ne、NOT、ge、le、in)。

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

-OtherMail

使用者的其他電子郵件地址清單;例如:[''bob@contoso.com,''Robert@fabrikam.com]。注意:雖然此屬性可以包含輔色字元,但它們可能會對使用者的第一方應用程式造成存取問題。支援$filter(eq、NOT、ge、le、in、startsWith)。

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

-PassThru

當命令成功時傳回 true

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

-Password

用戶的密碼。 建立使用者時需要這個屬性。

它可以更新,但用戶必須變更下一次登入的密碼。

密碼必須符合使用者 passwordPolicies 屬性的 speci./fied 最低需求。 根據預設,需要強密碼。 使用此方法變更密碼時,AccountEnabled 會設定為 true。

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

-PasswordPolicy

指定用戶的密碼原則。 這個值是列舉,其中一個可能值為 DisableStrongPassword,允許比指定預設原則更弱的密碼。 您也可以指定 DisablePasswordExpiration。 兩者可以一起指定;例如:DisablePasswordExpiration、DisableStrongPassword.Supports $filter (ne, NOT)。

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

-PasswordProfile

passwordProfile 若要建構,請參閱 PASSWORDPROFILE 屬性和建立哈希表的 NOTES 一節。

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

-PostalCode

用戶郵政地址的郵遞區號。 郵遞區編碼專屬於用戶的國家/地區。 在美國的 美國 中,此屬性包含郵遞郵遞編碼。 最大長度為 40 個字元。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。

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

-PreferredLanguage

使用者慣用的語言。 應遵循 ISO 639-1 程式代碼;例如 en-US。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。

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

-ShowInAddressList

如果 Outlook 全域通訊清單應該包含此使用者,則為 true,否則為 false。 如果未設定,則會將此視為 true。 對於透過邀請管理員邀請的使用者,此屬性會設定為 false。 支援 $filter (eq, ne, NOT, in) 。

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

-State

用戶位址中的州或省。 長度上限為 128 個字元。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。

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

-StreetAddress

使用者營業地點的街道位址。 長度上限是 1024 個字元。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。

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

-Surname

使用者的姓氏(姓氏或姓氏)。 最大長度為64個字元。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。

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

-UPNOrObjectId

要更新之用戶的用戶主體名稱或物件標識碼。

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

-UsageLocation

兩個字母國家/地區代碼(ISO 標準 3166)。 由於法律要求檢查國家/地區服務可用性,因此需要指派授權的使用者。 範例包括:US、JP 和 GB。 不可為 Null。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。

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

-UserPrincipalName

使用者的使用者主要名稱 (UPN)。 UPN 是以因特網標準 RFC 822 為基礎的使用者因特網樣式登入名稱。 依照慣例,這應該對應至使用者的電子郵件名稱。 一般格式是alias@domain,其中網域必須存在於租使用者的已驗證網域集合中。 建立使用者時需要這個屬性。 您可以從組織的 verifiedDomains 屬性存取租使用者的已驗證網域。注意:雖然此屬性可以包含輔色字元,但它們可能會對使用者的第一方應用程式造成存取問題。 支援$filter(eq、ne、NOT、ge、le、in、startsWith、endsWith) 和 $orderBy。

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

-UserType

字串值,可用來分類目錄中的用戶類型,例如 Member 和 Guest。 支援$filter (eq, ne, NOT, in, in, ) 。

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

-WhatIf

顯示執行 Cmdlet 後會發生的情況。 未執行 Cmdlet。

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

輸入

IMicrosoftGraphUser

輸出

Boolean

備註

別名

Set-AzADUser

COMPLEX PARAMETER PROPERTIES

若要建立以下所述的參數,請建構包含適當屬性的哈希表。 如需哈希表的相關信息,請執行 Get-Help about_Hash_Tables。

IDENTITY <IMicrosoftGraphObjectIdentity[]>:代表可用來登入此用戶帳戶的身分識別。 身分識別可由 Microsoft 提供(也稱為本機帳戶)、組織或社交識別提供者,例如 Facebook、Google 和 Microsoft,以及系結至用戶帳戶。 可能包含多個具有相同 signInType 值的專案。 僅支援 signInType 不是 userPrincipalName 的 $filter (eq)。

  • [Issuer <String>]:指定身分識別的簽發者,例如 facebook.com。對於本機帳戶(其中 signInType 不是同盟),此屬性是本機 B2C 租用戶預設功能變數名稱,例如 contoso.onmicrosoft.com。對於來自其他 Microsoft Entra 組織的外部使用者,這會是同盟組織的網域,例如 contoso.com.Supports $filter。 512 個字元的限制。
  • [IssuerAssignedId <String>]:指定簽發者指派給使用者的唯一標識符。 簽發者和issuerAssignedId的組合在組織內必須是唯一的。 代表使用者的登入名稱,當 signInType 設定為 emailAddress 或 userName 時(也稱為本機帳戶)。當 signInType 設定為:emailAddress,或以 emailAddress1 之類的 emailAddress 開頭的自定義字串時,issuerAssignedId 必須是有效的電子郵件地址userName,issuerAssignedId 必須是電子郵件位址的有效本機部分$filter。 100 個字元的限制。
  • [SignInType <String>]:指定目錄中的使用者登入類型,例如 emailAddress、userName 或同盟。 在這裡,同盟代表簽發者中使用者的唯一標識符,該標識碼可以是簽發者選擇的任何格式。 當登入類型設定為 emailAddress 或 userName 時,會在 issuerAssignedId 上強制執行其他驗證。 這個屬性也可以設定為任何自定義字串。

INPUTOBJECT <IMicrosoftGraphUser>:使用者輸入物件

  • [(Any) <Object>]:這表示任何屬性都可以新增至這個物件。
  • [DeletedDateTime <DateTime?>]
  • [DisplayName <String>]:在目錄中顯示的名稱
  • [AccountEnabled <Boolean?>]:如果帳戶已啟用,則為 true;否則為 false。 建立使用者時需要這個屬性。 支援$filter(eq、ne、NOT 和 in)。
  • [AgeGroup <String>]:設定使用者的年齡群組。 允許的值:null、minor、notAdult 和成人。 如需進一步資訊,請參閱法律年齡群組屬性定義。 支援$filter(eq、ne、NOT 和 in)。
  • [ApproximateLastSignInDateTime <DateTime?>]:時間戳類型代表使用 ISO 8601 格式的日期和時間資訊,且一律為 UTC 時間。 例如,2014 年 1 月 1 日午夜 UTC 是 2014-01-01T00:00:00Z。 唯讀。 支援$filter(eq、ne、not、ge、le 和 eq on null 值)和 $orderBy。
  • [City <String>]:使用者所在的城市。 長度上限為 128 個字元。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。
  • [CompanyName <String>]:使用者相關聯的公司名稱。 此屬性對於描述外部使用者所來自的公司很有用。 公司名稱的最大長度為64個字元。支援$filter(eq、ne、NOT、ge、le、in、startsWith)。
  • [ComplianceExpirationDateTime <DateTime?>]:裝置不再被視為符合規範時的時間戳。 時間戳類型代表使用 ISO 8601 格式的日期和時間資訊,且一律為 UTC 時間。 例如,2014 年 1 月 1 日午夜 UTC 是 2014-01-01T00:00:00Z。 唯讀。
  • [ConsentProvidedForMinor <String>]:設定是否已取得未成年人的同意。 允許的值:Null、授與、拒絕和 notRequired。 如需進一步資訊,請參閱法律年齡群組屬性定義。 支援$filter(eq、ne、NOT 和 in)。
  • [Country <String>]:使用者所在的國家/地區;例如,美國或英國。 長度上限為 128 個字元。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。
  • [Department <String>]:用戶運作所在的部門名稱。 最大長度為64個字元。支援$filter(eq、ne、NOT、ge、le 和 in 運算符)。
  • [DeviceVersion <Int32?>]:僅供內部使用。
  • [EmployeeHireDate <DateTime?>]:僱用使用者的日期和時間,或在未來僱用時開始工作。 支援$filter (eq, ne, NOT , ge, le, in) 。
  • [EmployeeId <String>]:組織指派給使用者的員工標識符。 支援$filter (eq, ne, NOT , ge, le, in, startsWith) 。
  • [EmployeeOrgData <IMicrosoftGraphEmployeeOrgData>]:employeeOrgData
    • [(Any) <Object>]:這表示任何屬性都可以新增至這個物件。
    • [CostCenter <String>]:與使用者相關聯的成本中心。 只在$select傳回。 支援$filter。
    • [Division <String>]:用戶運作所在的除法名稱。 只在$select傳回。 支援$filter。
  • [EmployeeType <String>]:擷取企業背景工作角色類型。 例如,員工、承包商、顧問或廠商。 支援$filter (eq, ne, NOT , ge, le, in, startsWith) 。
  • [ExternalUserState <String>]:對於使用邀請 API 邀請給租使用者的外部使用者,此屬性代表受邀使用者的邀請狀態。 對於受邀的用戶,狀態可以是PendingAcceptance或 Accepted,或所有其他使用者的 Null。 支援 $filter (eq, ne, NOT , in) 。
  • [ExternalUserStateChangeDateTime <DateTime?>]:顯示 externalUserState 屬性最新變更的時間戳。 支援 $filter (eq, ne, NOT , in) 。
  • [FaxNumber <String>]:用戶的傳真號。 支援$filter (eq, ne, NOT , ge, le, in, startsWith) 。
  • [GivenName <String>]:使用者的指定名稱(名字)。 最大長度為64個字元。 支援$filter (eq, ne, NOT , ge, le, in, startsWith) 。
  • [Identity <IMicrosoftGraphObjectIdentity[]>]:表示可用來登入此用戶帳戶的身分識別。 身分識別可由 Microsoft 提供(也稱為本機帳戶)、組織或社交識別提供者,例如 Facebook、Google 和 Microsoft,以及系結至用戶帳戶。 可能包含多個具有相同 signInType 值的專案。 僅支援 signInType 不是 userPrincipalName 的 $filter (eq)。
    • [Issuer <String>]:指定身分識別的簽發者,例如 facebook.com。對於本機帳戶(其中 signInType 不是同盟),此屬性是本機 B2C 租用戶預設功能變數名稱,例如 contoso.onmicrosoft.com。對於來自其他 Microsoft Entra 組織的外部使用者,這會是同盟組織的網域,例如 contoso.com.Supports $filter。 512 個字元的限制。
    • [IssuerAssignedId <String>]:指定簽發者指派給使用者的唯一標識符。 簽發者和issuerAssignedId的組合在組織內必須是唯一的。 代表使用者的登入名稱,當 signInType 設定為 emailAddress 或 userName 時(也稱為本機帳戶)。當 signInType 設定為:emailAddress,或以 emailAddress1 之類的 emailAddress 開頭的自定義字串時,issuerAssignedId 必須是有效的電子郵件地址userName,issuerAssignedId 必須是電子郵件位址的有效本機部分$filter。 100 個字元的限制。
    • [SignInType <String>]:指定目錄中的使用者登入類型,例如 emailAddress、userName 或同盟。 在這裡,同盟代表簽發者中使用者的唯一標識符,該標識碼可以是簽發者選擇的任何格式。 當登入類型設定為 emailAddress 或 userName 時,會在 issuerAssignedId 上強制執行其他驗證。 這個屬性也可以設定為任何自定義字串。
  • [IsResourceAccount <Boolean?>]:請勿使用 - 保留供日後使用。
  • [JobTitle <String>]:用戶的職稱。 長度上限為 128 個字元。 支援$filter (eq, ne, NOT , ge, le, in, startsWith) 。
  • [Mail <String>]:使用者的 SMTP 位址, admin@contoso.com例如 。 此屬性的變更也會更新使用者的 proxyAddresses 集合,以將值納入 SMTP 位址。 雖然這個屬性可以包含輔色字元,但使用這些字元可能會對使用者的其他 Microsoft 應用程式造成存取問題。 支援$filter(eq、ne、NOT、ge、le、in、startsWith、endsWith)。
  • [MailNickname <String>]:使用者的郵件別名。 建立使用者時,必須指定這個屬性。 最大長度為64個字元。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。
  • [Manager <IMicrosoftGraphDirectoryObject>]:代表 Microsoft Entra 物件。 directoryObject 類型是許多其他目錄實體類型的基底類型。
    • [DeletedDateTime <DateTime?>]
    • [DisplayName <String>]:在目錄中顯示的名稱
    • [AssignedPlan <IMicrosoftGraphAssignedPlan[]>]:與租使用者相關聯的服務方案集合。 不可為 Null。
      • [AssignedDateTime <DateTime?>]:指派計劃的日期和時間。 Timestamp 類型代表使用 ISO 8601 格式的日期和時間資訊,且一律為 UTC 時間。 例如,2014 年 1 月 1 日午夜 UTC 是 2014-01-01T00:00:00Z。
      • [CapabilityStatus <String>]:功能指派的條件。 可能的值為 Enabled、Warning、Suspended、Deleted、LockedOut。 請參閱每個值的詳細描述。
      • [Service <String>]:服務的名稱;例如,exchange。
      • [ServicePlanId <String>]:識別服務方案的 GUID。 如需 GUID 及其對等易記服務名稱的完整清單,請參閱授權的產品名稱和服務方案識別碼。
    • [Branding <IMicrosoftGraphOrganizationalBranding>]:organizationalBranding
      • [(Any) <Object>]:這表示任何屬性都可以新增至這個物件。
      • [BackgroundColor <String>]:將在低頻寬連線中取代背景影像的色彩。 建議您使用橫幅標誌或組織色彩的主要色彩。 以十六進位格式指定此值,例如,白色是 #FFFFFF。
      • [BackgroundImage <Byte[]>]:顯示為登入頁面背景的影像。 允許的類型為 PNG 或 JPEG 不小於 300 KB,且不大於 1920 × 1080 像素。 較小的映像會降低頻寬需求,並加快頁面載入速度。
      • [BackgroundImageRelativeUrl <String>]:backgroundImage 屬性的相對 URL,結合 cdnList 中的 CDN 基底 URL,以提供 CDN 所提供的版本。 唯讀。
      • [BannerLogo <Byte[]>]:出現在登入頁面上的公司標誌橫幅版本。 允許的類型為 PNG 或 JPEG,不大於 36 × 245 圖元。 我們建議使用透明影像,且標誌周圍沒有邊框間距。
      • [BannerLogoRelativeUrl <String>]:bannerLogo 屬性的相對 URL,結合 cdnList 中的 CDN 基底 URL,以提供 CDN 所提供的唯讀版本。 唯讀。
      • [CdnList <String[]>]:提供目前資源資產之所有可用CDN提供者的基底URL清單。 數個 CDN 提供者會同時用於讀取要求的高可用性。 唯讀。
      • [SignInPageText <String>]:出現在登入方塊底部的文字。 您可以使用此功能來傳達其他資訊,例如電話號碼到技術支援中心或法律聲明。 此文字必須是 Unicode,且不可超過 1024 個字元。
      • [SquareLogo <Byte[]>]:Windows 10 現成體驗中出現的公司標誌正方形版本(OOBE),以及啟用 Windows Autopilot 進行部署時。 允許的類型為 PNG 或 JPEG,大小不超過 240 x 240 像素,大小不超過 10 KB。 我們建議使用透明影像,且標誌周圍沒有邊框間距。
      • [SquareLogoRelativeUrl <String>]:squareLogo 屬性的相對 URL,結合 cdnList 中的 CDN 基底 URL,以提供 CDN 所提供的版本。 唯讀。
      • [UsernameHintText <String>]:在登入畫面的用戶名稱文字框中顯示為提示的字串。 此文字必須是 Unicode,不含連結或程式代碼,且不能超過 64 個字元。
      • [Id <String>]:實體的唯一標識符。 唯讀。
      • [Localization <IMicrosoftGraphOrganizationalBrandingLocalization[]>]:根據地區設定新增不同的商標。
        • [BackgroundColor <String>]:將在低頻寬連線中取代背景影像的色彩。 建議您使用橫幅標誌或組織色彩的主要色彩。 以十六進位格式指定此值,例如,白色是 #FFFFFF。
        • [BackgroundImage <Byte[]>]:顯示為登入頁面背景的影像。 允許的類型為 PNG 或 JPEG 不小於 300 KB,且不大於 1920 × 1080 像素。 較小的映像會降低頻寬需求,並加快頁面載入速度。
        • [BackgroundImageRelativeUrl <String>]:backgroundImage 屬性的相對 URL,結合 cdnList 中的 CDN 基底 URL,以提供 CDN 所提供的版本。 唯讀。
        • [BannerLogo <Byte[]>]:出現在登入頁面上的公司標誌橫幅版本。 允許的類型為 PNG 或 JPEG,不大於 36 × 245 圖元。 我們建議使用透明影像,且標誌周圍沒有邊框間距。
        • [BannerLogoRelativeUrl <String>]:bannerLogo 屬性的相對 URL,結合 cdnList 中的 CDN 基底 URL,以提供 CDN 所提供的唯讀版本。 唯讀。
        • [CdnList <String[]>]:提供目前資源資產之所有可用CDN提供者的基底URL清單。 數個 CDN 提供者會同時用於讀取要求的高可用性。 唯讀。
        • [SignInPageText <String>]:出現在登入方塊底部的文字。 您可以使用此功能來傳達其他資訊,例如電話號碼到技術支援中心或法律聲明。 此文字必須是 Unicode,且不可超過 1024 個字元。
        • [SquareLogo <Byte[]>]:Windows 10 現成體驗中出現的公司標誌正方形版本(OOBE),以及啟用 Windows Autopilot 進行部署時。 允許的類型為 PNG 或 JPEG,大小不超過 240 x 240 像素,大小不超過 10 KB。 我們建議使用透明影像,且標誌周圍沒有邊框間距。
        • [SquareLogoRelativeUrl <String>]:squareLogo 屬性的相對 URL,結合 cdnList 中的 CDN 基底 URL,以提供 CDN 所提供的版本。 唯讀。
        • [UsernameHintText <String>]:在登入畫面的用戶名稱文字框中顯示為提示的字串。 此文字必須是 Unicode,不含連結或程式代碼,且不能超過 64 個字元。
        • [Id <String>]:實體的唯一標識符。 唯讀。
    • [BusinessPhone <String[]>]:組織的電話號碼。 雖然這是字串集合,但此屬性只能設定一個數位。
    • [CertificateBasedAuthConfiguration <IMicrosoftGraphCertificateBasedAuthConfiguration[]>]:用來管理憑證型驗證組態的導覽屬性。 在集合中只能建立 CertificateBasedAuthConfiguration 的單一實例。
      • [Id <String>]:實體的唯一標識符。 唯讀。
      • [CertificateAuthority <IMicrosoftGraphCertificateAuthority[]>]:建立受信任憑證鏈結的證書頒發機構單位集合。
        • [Certificate <Byte[]>]:必填。 代表公用憑證的base64編碼字串。
        • [CertificateRevocationListUrl <String>]:證書吊銷清單的 URL。
        • [DeltaCertificateRevocationListUrl <String>]:URL 包含自上次建立完整證書吊銷列表以來所有撤銷的憑證清單。
        • [IsRootAuthority <Boolean?>]:必填。 如果受信任的憑證是根授權單位,則為 true,如果信任的憑證是中繼授權單位,則為 false。
        • [Issuer <String>]:憑證的簽發者,從憑證值計算。 唯讀。
        • [IssuerSki <String>]:憑證的主體密鑰標識碼,是從憑證值計算而來。 唯讀。
    • [City <String>]:組織位址的城市名稱。
    • [Country <String>]:組織位址的國家/地區名稱。
    • [CountryLetterCode <String>]:ISO 3166-2 格式之組織的國家或地區縮寫。
    • [CreatedDateTime <DateTime?>]:建立組織時的時間戳。 無法修改此值,而且會在建立組織時自動填入。 Timestamp 類型代表使用 ISO 8601 格式的日期和時間資訊,且一律為 UTC 時間。 例如,2014 年 1 月 1 日午夜 UTC 是 2014-01-01T00:00:00Z。 唯讀。
    • [Extension <IMicrosoftGraphExtension[]>]:為組織定義的開放延伸模組集合。 唯讀。 可為 Null。
      • [Id <String>]:實體的唯一標識符。 唯讀。
    • [MarketingNotificationEmail <String[]>]:不可為 Null。
    • [MobileDeviceManagementAuthority <MdmAuthority?>]:行動裝置管理授權單位。
    • [OnPremisesLastSyncDateTime <DateTime?>]:租使用者上次與內部部署目錄同步的時間和日期。 Timestamp 類型代表使用 ISO 8601 格式的日期和時間資訊,且一律為 UTC 時間。 例如,2014 年 1 月 1 日午夜 UTC 是 2014-01-01T00:00:00Z。 唯讀。
    • [OnPremisesSyncEnabled <Boolean?>]:如果此對像是從內部部署目錄同步處理,則為 true;如果此物件原本是從內部部署目錄同步處理,但不再同步處理,則為 false。 可為 Null。 如果從未從內部部署目錄同步處理此物件,則為 null (預設值)。
    • [PostalCode <String>]:組織的地址郵遞區編碼。
    • [PreferredLanguage <String>]:組織慣用的語言。 應遵循 ISO 639-1 程式代碼;例如,en。
    • [PrivacyProfile <IMicrosoftGraphPrivacyProfile>]:privacyProfile
      • [(Any) <Object>]:這表示任何屬性都可以新增至這個物件。
      • [ContactEmail <String>]:隱私聲明聯繫人的有效 smtp 電子郵件位址。 非必要。
      • [StatementUrl <String>]:開頭為 http:// 或 https:// 的有效 URL 格式。 長度上限為 255 個字元。 導向公司隱私聲明的 URL。 非必要。
    • [ProvisionedPlan <IMicrosoftGraphProvisionedPlan[]>]:不可為 Null。
      • [CapabilityStatus <String>]:例如『Enabled』。
      • [ProvisioningStatus <String>]:例如『Success』。
      • [Service <String>]:服務的名稱;例如,'AccessControlS2S'
    • [SecurityComplianceNotificationMail <String[]>]
    • [SecurityComplianceNotificationPhone <String[]>]
    • [State <String>]:組織地址的狀態名稱。
    • [Street <String>]:組織的位址街道名稱。
    • [TechnicalNotificationMail <String[]>]:不可為 Null。
    • [TenantType <String>]
    • [VerifiedDomain <IMicrosoftGraphVerifiedDomain[]>]:與此租使用者相關聯的網域集合。 不可為 Null。
      • [Capability <String>]:例如,Email、OfficeCommunicationsOnline。
      • [IsDefault <Boolean?>]:如果這是與租使用者相關聯的預設網域,則為 true;否則為 false。
      • [IsInitial <Boolean?>]:如果這是與租使用者相關聯的初始網域,則為 true;否則為 false。
      • [Name <String>]:功能變數名稱;例如,contoso.onmicrosoft.com。
      • [Type <String>]:例如Managed。
    • [AddIn <IMicrosoftGraphAddIn[]>]:定義取用服務可用來在特定內容中呼叫應用程式的自定義行為。 例如,可以轉譯檔案數據流的應用程式可能會為其 『FileHandler』 功能設定 addIns 屬性。 這可讓 Office 365 等服務在使用者正在處理的文件內容中呼叫應用程式。
      • [Id <String>]
      • [Property <IMicrosoftGraphKeyValue[]>]:
        • [Key <String>]:關鍵。
        • [Value <String>]:價值。
      • [Type <String>]
    • [Api <IMicrosoftGraphApiApplication>]:apiApplication
      • [(Any) <Object>]:這表示任何屬性都可以新增至這個物件。
      • [AcceptMappedClaim <Boolean?>]:若為 true,則允許應用程式使用宣告對應,而不需指定自定義簽署密鑰。
      • [KnownClientApplication <String[]>]:如果您有包含兩個部分的解決方案,則用於統合同意:用戶端應用程式和自定義 Web API 應用程式。 如果您將用戶端應用程式的 appID 設定為此值,則使用者只會同意用戶端應用程式一次。 Microsoft Entra ID 知道同意用戶端表示隱含地同意 Web API,並同時自動為這兩個 API 布建服務主體。 用戶端和 Web API 應用程式都必須在相同的租用戶中註冊。
      • [Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]:此應用程式註冊所代表之 Web API 所公開之委派許可權的定義。 用戶端應用程式可能會要求這些委派的許可權,並在同意期間由使用者或系統管理員授與。 委派的許可權有時稱為 OAuth 2.0 範圍。
        • [AdminConsentDescription <String>]:委派許可權的描述,是要由系統管理員代表所有使用者授與許可權來讀取。 此文字會出現在全租用戶系統管理員同意體驗中。
        • [AdminConsentDisplayName <String>]:許可權的標題,是要由系統管理員代表所有使用者授與許可權的讀取。
        • [Id <String>]:資源應用程式所定義委派許可權集合內的唯一委派許可權標識符。
        • [IsEnabled <Boolean?>]:建立或更新許可權時,此屬性必須設定為 true(這是預設值)。 若要刪除許可權,必須先將此屬性設定為 false。 此時,在後續呼叫中,可能會移除許可權。
        • [Origin <String>]
        • [Type <String>]:指定是否應該將此委派許可權視為安全,讓非系統管理員使用者代表自己同意,還是需要系統管理員才能同意許可權。 這會是預設行為,但每位客戶都可以選擇自定義其組織中的行為(藉由允許、限制或限制使用者同意此委派的許可權。
        • [UserConsentDescription <String>]:委派許可權的描述,這是使用者代表自己授與許可權所要讀取的描述。 此文字會出現在使用者只代表自己同意的同意體驗中。
        • [UserConsentDisplayName <String>]:許可權的標題,是要由使用者代表自己授與許可權來讀取。 此文字會出現在使用者只代表自己同意的同意體驗中。
        • [Value <String>]:指定要包含在存取令牌中 scp (scope) 宣告中的值。 長度不得超過 120 個字元。 允許的字元為 : 。 # $ % & ' ( ) * + , - . / : ;= ? @ [ ] ^ + _ { } ~,以及範圍 0-9、A-Z 和 a-z 中的字元。 不允許任何其他字元,包括空格符。 可能不是以 .開頭。
      • [PreAuthorizedApplication <IMicrosoftGraphPreAuthorizedApplication[]>]:列出預先授權且具有指定委派許可權的用戶端應用程式,以存取此應用程式的 API。 使用者不需要同意任何預先授權的應用程式(針對指定的許可權)。 不過,在 preAuthorizedApplications 中未列出的任何其他許可權(例如透過累加同意要求)都需要使用者同意。
        • [AppId <String>]:應用程式的唯一標識符。
        • [DelegatedPermissionId <String[]>]:應用程式所需的 oauth2PermissionScopes 唯一標識符。
      • [RequestedAccessTokenVersion <Int32?>]:指定此資源預期的存取令牌版本。 這會變更與用來要求存取令牌的端點或客戶端無關的 JWT 版本和格式。 用戶端會選擇使用的端點 v1.0 或 v2.0,且只會影響id_tokens的版本。 資源必須明確設定 requestedAccessTokenVersion,以指出支援的存取令牌格式。 requestedAccessTokenVersion 的可能值為 1、2 或 null。 如果值為 null,則預設為 1,這會對應至 v1.0 端點。 如果應用程式的 signInAudience 設定為 AzureADandPersonalMicrosoftAccount,此屬性的值必須是 2
    • [AppRole <IMicrosoftGraphAppRole[]>]:指派給應用程式的角色集合。 透過應用程式角色指派,這些角色可以指派給與其他應用程式相關聯的使用者、群組或服務主體。 不可為 Null。
      • [AllowedMemberType <String[]>]:指定此應用程式角色是否可以指派給使用者和群組(藉由將 ['User']] 設定為 ['User'])、其他應用程式的 (藉由將 ['Application'] 設定為 ['Application'] 或兩者 (藉由設定為 ['User', 'Application'])。 支援指派給其他應用程式服務主體的應用程式角色也稱為應用程式許可權。 應用程式實體上定義的應用程式角色僅支援 『Application』 值。
      • [Description <String>]:應用程式角色的描述。 當應用程式角色被指派時,如果應用程式角色在同意體驗期間作為應用程式許可權,就會顯示此專案。
      • [DisplayName <String>]:顯示出現在應用程式角色指派和同意體驗中之許可權的名稱。
      • [Id <String>]:appRoles 集合內的唯一角色標識符。 建立新的應用程式角色時,必須提供新的 Guid 識別碼。
      • [IsEnabled <Boolean?>]:建立或更新應用程式角色時,這必須設定為 true(這是預設值)。 若要刪除角色,這必須先設定為 false。 此時,在後續的呼叫中,可能會移除此角色。
      • [Value <String>]:指定要包含在標識元令牌中角色宣告的值,以及驗證指派的使用者或服務主體的存取令牌。 長度不得超過 120 個字元。 允許的字元為 : 。 # $ % & ' ( ) * + , - . / : ;= ? @ [ ] ^ + _ { } ~,以及範圍 0-9、A-Z 和 a-z 中的字元。 不允許任何其他字元,包括空格符。 可能不是以 .開頭。
    • [ApplicationTemplateId <String>]:applicationTemplate 的唯一標識符。
    • [CreatedOnBehalfOfDeletedDateTime <DateTime?>]
    • [CreatedOnBehalfOfDisplayName <String>]:在目錄中顯示的名稱
    • [Description <String>]:應用程式的選擇性描述。 預設會傳回 。 支援$filter(eq、ne、NOT、ge、le、startsWith)和$search。
    • [DisabledByMicrosoftStatus <String>]:指定 Microsoft 是否已停用已註冊的應用程式。 可能的值為:null(預設值)、NotDisabled 和 DisabledDueToViolationOfServicesAgreement(原因可能包括可疑、濫用或惡意活動,或違反 Microsoft 服務合約)。 支援$filter(eq、ne、NOT)。
    • [FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]:應用程式的同盟身分識別。 支援$expand和$filter (計算空白集合時 eq)。
      • [Audience <String[]>]:列出可出現在外部令牌中的物件。 此欄位為必要欄位,預設為 「api://AzureADTokenExchange」。 它說,Microsoft 身分識別平台 應該在傳入令牌的 aud 宣告中接受什麼。 此值代表外部識別提供者中的 Microsoft Entra 識別碼,而且在識別提供者之間沒有固定值 - 您可能需要在識別提供者中建立新的應用程式註冊,以作為此令牌的物件。 必要。
      • [Description <String>]:未驗證的使用者提供的同盟身分識別認證描述。 選擇性。
      • [Issuer <String>]:外部識別提供者的 URL,必須符合所交換之外部令牌的簽發者宣告。 簽發者和主體值的組合在應用程式上必須是唯一的。 必要。
      • [Name <String>]:是同盟身分識別認證的唯一標識符,其字元限制為 120 個字元,而且必須是 URL 易記。 一旦建立它就不可變了。 必要。 不可為 Null。 支援$filter (eq)。
      • [Subject <String>]:必填。 外部識別提供者內外部軟體工作負載的標識碼。 就像物件值一樣,它沒有固定格式,因為每個識別提供者都會使用自己的格式,有時是 GUID,有時是冒號分隔標識符,有時是任意字串。 此處的值必須符合呈現給 Microsoft Entra ID 之令牌內的子宣告。 簽發者和主體的組合在應用程式上必須是唯一的。 支援$filter (eq)。
    • [GroupMembershipClaim <String>]:設定應用程式預期在使用者或 OAuth 2.0 存取令牌中發出的群組宣告。 若要設定此屬性,請使用下列其中一個字串值:None、SecurityGroup(適用於安全組和 Microsoft Entra 角色)、All(這會取得登入使用者所屬的所有安全組、通訊群組和 Microsoft Entra 目錄角色)。
    • [HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]:
      • [AppliesTo <IMicrosoftGraphDirectoryObject[]>]
      • [Definition <String[]>]:字串集合,包含定義原則規則和設定的 JSON 字串。 定義語法會因每個衍生原則類型而有所不同。 必要。
      • [IsOrganizationDefault <Boolean?>]:如果設定為 true,則會啟用此原則。 相同原則類型可以有許多原則,但只有一個原則可以啟用為組織預設值。 選擇性的預設值為 false。
      • [Description <String>]:此原則的描述。
      • [DeletedDateTime <DateTime?>]
      • [DisplayName <String>]:在目錄中顯示的名稱
    • [IdentifierUri <String[]>]:識別其 Microsoft Entra 租使用者內之應用程式的 URI,如果應用程式是多租使用者,則為已驗證的自定義網域。 如需詳細資訊,請參閱 Application Objects 和服務主體物件。 在多重值屬性上篩選表達式需要任何運算元。 不可為 Null。 支援$filter(eq、ne、ge、le、startsWith)。
    • [Info <IMicrosoftGraphInformationalUrl>]:informationalUrl
    • [IsDeviceOnlyAuthSupported <Boolean?>]:指定此應用程式是否支援沒有使用者的裝置驗證。 預設值為 false。
    • [IsFallbackPublicClient <Boolean?>]:將後援應用程式類型指定為公用用戶端,例如在行動裝置上執行的已安裝應用程式。 默認值為 false,表示後援應用程式類型是機密用戶端,例如 Web 應用程式。 在某些情況下,Microsoft Entra ID 無法判斷用戶端應用程式類型。 例如,未指定重新導向 URI 的情況下設定應用程式的 ROPC 流程。 在這些情況下,Microsoft Entra ID 會根據此屬性的值來解譯應用程序類型。
    • [KeyCredentials <IMicrosoftGraphKeyCredential[]>]:與應用程式相關聯的密鑰認證集合。 不可為 Null。 支援$filter(eq、NOT、ge、le)。
      • [CustomKeyIdentifier <Byte[]>]:自定義金鑰標識碼
      • [DisplayName <String>]:索引鍵的易記名稱。 選擇性。
      • [EndDateTime <DateTime?>]:認證到期的日期和時間。Timestamp 類型代表使用 ISO 8601 格式的日期和時間資訊,且一律為 UTC 時間。 例如,2014 年 1 月 1 日午夜 UTC 為 2014-01-01T00:00:00Z
      • [Key <Byte[]>]:金鑰認證的值。 應該是基底 64 編碼值。
      • [KeyId <String>]:金鑰的唯一識別碼 (GUID)。
      • [StartDateTime <DateTime?>]:認證生效的日期和時間。Timestamp 類型代表使用 ISO 8601 格式的日期和時間資訊,且一律為 UTC 時間。 例如,2014 年 1 月 1 日午夜 UTC 為 2014-01-01T00:00:00Z
      • [Type <String>]:金鑰認證的類型;例如,'Symmetric'。
      • [Usage <String>]:描述金鑰可用用途的字串;例如,『Verify』。
    • [Logo <Byte[]>]:應用程式的主要標誌。 不可為 Null。
    • [Note <String>]:與應用程式管理相關的注意事項。
    • [Oauth2RequirePostResponse <Boolean?>]
    • [OptionalClaim <IMicrosoftGraphOptionalClaims>]:optionalClaims
      • [(Any) <Object>]:這表示任何屬性都可以新增至這個物件。
      • [AccessToken <IMicrosoftGraphOptionalClaim[]>]:JWT 存取令牌中傳回的選擇性宣告。
        • [AdditionalProperty <String[]>]:宣告的其他屬性。 如果這個集合中有屬性,它會修改 name 屬性中指定的選擇性宣告行為。
        • [Essential <Boolean?>]:如果值為 true,用戶端所指定的宣告是必要的,以確保終端使用者要求之特定工作的順利授權體驗。 預設值為 false。
        • [Name <String>]:選擇性宣告的名稱。
        • [Source <String>]:宣告的來源(目錄物件)。 延伸模組屬性中有預先定義的宣告和用戶定義宣告。 如果來源值為 null,則宣告是預先定義的選擇性宣告。 如果來源值是user,name屬性中的值就是用戶對象的擴充屬性。
      • [IdToken <IMicrosoftGraphOptionalClaim[]>]:JWT 識別元令牌中傳回的選擇性宣告。
      • [Saml2Token <IMicrosoftGraphOptionalClaim[]>]:SAML 令牌中傳回的選擇性宣告。
    • [ParentalControlSetting <IMicrosoftGraphParentalControlSettings>]:p arentalControl 設定
      • [(Any) <Object>]:這表示任何屬性都可以新增至這個物件。
      • [CountriesBlockedForMinor <String[]>]:指定兩個字母的 ISO 國家/地區代碼。 針對此清單中指定國家/地區的未成年人,將會封鎖應用程式的存取權。
      • [LegalAgeGroupRule <String>]:指定適用於應用程式使用者的法律年齡群組規則。 可以設定為下列其中一個值:ValueDescriptionAllowDefault。 強制執行法律最低要求。 這表示歐盟和韓國的未成年人需要家長同意。RequireConsentForPrivacyServicesEnforces 用戶必須指定出生日期,以符合 COPPA 規則。 RequireConsentForMinorsRequires 18 歲以下年齡的家長同意,無論國家/地區未成年人規則為何。RequireConsentForKidsRequires 家長同意年齡低於 14 歲,無論國家/地區未成年人規則為何。BlockMinorsBlocks 未成年人無法使用應用程式。
    • [PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]:與應用程式相關聯的密碼認證集合。 不可為 Null。
      • [CustomKeyIdentifier <Byte[]>]:請勿使用。
      • [DisplayName <String>]:密碼的易記名稱。 選擇性。
      • [EndDateTime <DateTime?>]:使用 ISO 8601 格式表示密碼到期的日期和時間,且一律為 UTC 時間。 例如,2014 年 1 月 1 日午夜 UTC 是 2014-01-01T00:00:00Z。 選擇性。
      • [KeyId <String>]:密碼的唯一標識符。
      • [StartDateTime <DateTime?>]:密碼生效的日期和時間。 Timestamp 類型代表使用 ISO 8601 格式的日期和時間資訊,且一律為 UTC 時間。 例如,2014 年 1 月 1 日午夜 UTC 是 2014-01-01T00:00:00Z。 選擇性。
    • [PublicClient <IMicrosoftGraphPublicClientApplication>]:publicClientApplication
      • [(Any) <Object>]:這表示任何屬性都可以新增至這個物件。
      • [RedirectUri <String[]>]:指定傳送使用者令牌以進行登入的 URL,或傳送 OAuth 2.0 授權碼和存取令牌的重新導向 URI。
    • [RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>]:指定應用程式需要存取的資源。 這個屬性也會指定每個資源所需的 OAuth 許可權範圍和應用程式角色集合。 此必要資源的存取設定會驅動同意體驗。 不可為 Null。 支援$filter(eq、NOT、ge、le)。
      • [ResourceAccess <IMicrosoftGraphResourceAccess[]>]:應用程式需要從指定資源取得的 OAuth2.0 許可權範圍和應用程式角色清單。
        • [Id <String>]:資源應用程式公開的其中一個 oauth2PermissionScopes 或 appRole 實例的唯一標識符。
        • [Type <String>]:指定id屬性參考 oauth2PermissionScopes 或 appRole。 可能的值為 Scope 或 Role。
      • [ResourceAppId <String>]:應用程式需要存取之資源的唯一標識符。 這應該等於目標資源應用程式上宣告的appId。
    • [SignInAudience <String>]:指定目前應用程式支援的 Microsoft 帳戶。 支援的值為:AzureADMyOrg、AzureADMultipleOrgs、AzureADandPersonalMicrosoftAccount、PersonalMicrosoftAccount。 如需詳細資訊,請參閱下表。 支援$filter(eq、ne、NOT)。
    • [Spa <IMicrosoftGraphSpaApplication>]:spaApplication
      • [(Any) <Object>]:這表示任何屬性都可以新增至這個物件。
      • [RedirectUri <String[]>]:指定傳送使用者令牌以進行登入的 URL,或傳送 OAuth 2.0 授權碼和存取令牌的重新導向 URI。
    • [Tag <String[]>]:可用來分類和識別應用程式的自定義字串。 不可為 Null。支援$filter(eq、NOT、ge、le、startsWith)。
    • [TokenEncryptionKeyId <String>]:從 keyCredentials 集合指定公鑰的 keyId。 設定時,Microsoft Entra ID 會使用此屬性所指向的密鑰來加密它發出的所有令牌。 接收加密令牌的應用程式程式代碼必須使用相符的私鑰來解密令牌,才能用於登入的使用者。
    • [TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]:
      • [AppliesTo <IMicrosoftGraphDirectoryObject[]>]
      • [Definition <String[]>]:字串集合,包含定義原則規則和設定的 JSON 字串。 定義語法會因每個衍生原則類型而有所不同。 必要。
      • [IsOrganizationDefault <Boolean?>]:如果設定為 true,則會啟用此原則。 相同原則類型可以有許多原則,但只有一個原則可以啟用為組織預設值。 選擇性的預設值為 false。
      • [Description <String>]:此原則的描述。
      • [DeletedDateTime <DateTime?>]
      • [DisplayName <String>]:在目錄中顯示的名稱
    • [TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]:指派給此應用程式的 tokenLifetimePolicies。 支援$expand。
      • [AppliesTo <IMicrosoftGraphDirectoryObject[]>]
      • [Definition <String[]>]:字串集合,包含定義原則規則和設定的 JSON 字串。 定義語法會因每個衍生原則類型而有所不同。 必要。
      • [IsOrganizationDefault <Boolean?>]:如果設定為 true,則會啟用此原則。 相同原則類型可以有許多原則,但只有一個原則可以啟用為組織預設值。 選擇性的預設值為 false。
      • [Description <String>]:此原則的描述。
      • [DeletedDateTime <DateTime?>]
      • [DisplayName <String>]:在目錄中顯示的名稱
    • [Web <IMicrosoftGraphWebApplication>]:webApplication
      • [(Any) <Object>]:這表示任何屬性都可以新增至這個物件。
      • [HomePageUrl <String>]:應用程式的首頁或登陸頁面。
      • [ImplicitGrantSetting <IMicrosoftGraphImplicitGrantSettings>]:implicitGrant 設定
        • [(Any) <Object>]:這表示任何屬性都可以新增至這個物件。
        • [EnableAccessTokenIssuance <Boolean?>]:指定此 Web 應用程式是否可以使用 OAuth 2.0 隱含流程來要求存取令牌。
        • [EnableIdTokenIssuance <Boolean?>]:指定此 Web 應用程式是否可以使用 OAuth 2.0 隱含流程來要求識別元令牌。
      • [LogoutUrl <String>]:指定 Microsoft 授權服務將使用的 URL,以使用前端通道、後端通道或 SAML 註銷通訊協定來登出使用者。
      • [RedirectUri <String[]>]:指定傳送使用者令牌以進行登入的 URL,或傳送 OAuth 2.0 授權碼和存取令牌的重新導向 URI。
    • [DataType <String>]:指定擴充屬性可以保存之值的數據類型。 支援下列值。 不可為 Null。 Binary - 256 個字節 maximumBooleanDateTime - 必須以 ISO 8601 格式指定。 將會以UTC儲存。整數 - 32 位值。LargeInteger - 64 位值。字串 - 最多 256 個字元
    • [Name <String>]:擴充屬性的名稱。 不可為 Null。
    • [TargetObject <String[]>]:支援下列值。 不可為 Null。 UserGroupOrganizationDeviceApplication
    • [Description <String>]:此原則的描述。
    • [AppliesTo <IMicrosoftGraphDirectoryObject[]>]
    • [Definition <String[]>]:字串集合,包含定義原則規則和設定的 JSON 字串。 定義語法會因每個衍生原則類型而有所不同。 必要。
    • [IsOrganizationDefault <Boolean?>]:如果設定為 true,則會啟用此原則。 相同原則類型可以有許多原則,但只有一個原則可以啟用為組織預設值。 選擇性的預設值為 false。
    • [AccountEnabled <Boolean?>]:如果已啟用服務主體帳戶,則為 true;否則為 false。 支援 $filter (eq, ne, NOT, in) 。
    • [AddIn <IMicrosoftGraphAddIn[]>]:定義取用服務可用來在特定內容中呼叫應用程式的自定義行為。 例如,可以轉譯檔案數據流的應用程式可能會為其 『FileHandler』 功能設定 addIns 屬性。 這可讓 Microsoft 365 等服務在使用者正在處理的文件內容中呼叫應用程式。
    • [AlternativeName <String[]>]:用來依訂用帳戶擷取服務主體、識別資源群組和受控識別的完整資源標識符。 支援$filter(eq、NOT、ge、le、startsWith)。
    • [AppDescription <String>]:相關聯應用程式公開的描述。
    • [AppDisplayName <String>]:相關聯應用程式公開的顯示名稱。
    • [AppId <String>]:相關聯應用程式的唯一標識碼(其 appId 屬性)。
    • [AppOwnerOrganizationId <String>]:包含註冊應用程式的租用戶標識碼。 這隻適用於應用程式所支援的服務主體。支援$filter(eq、ne、NOT、ge、le)。
    • [AppRole <IMicrosoftGraphAppRole[]>]:此服務主體所代表之應用程式所公開的角色。 如需詳細資訊,請參閱應用程式實體上的 appRoles 屬性定義。 不可為 Null。
    • [AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment[]>]:此應用程式或服務的應用程式角色指派,授與使用者、群組和其他服務主體。支援$expand。
      • [DeletedDateTime <DateTime?>]
      • [DisplayName <String>]:在目錄中顯示的名稱
      • [AppRoleId <String>]:指派給主體之應用程式角色的標識碼 (id)。 此應用程式角色必須在資源應用程式服務主體 (resourceId) 的 appRoles 屬性中公開。 如果資源應用程式未宣告任何應用程式角色,則可以指定默認應用程式角色標識碼 00000000-0000-0000-0000000000000,以發出主體指派給資源應用程式,而不需要任何特定應用程式角色。 建立時的必要專案。
      • [PrincipalId <String>]:授與應用程式角色之使用者、群組或服務主體的唯一標識碼(id)。 建立時的必要專案。
      • [ResourceDisplayName <String>]:進行指派之資源應用程式服務主體的顯示名稱。
      • [ResourceId <String>]:進行指派之資源服務主體的唯一標識碼(id)。 建立時的必要專案。 支援$filter(僅限 eq)。
    • [AppRoleAssignment <IMicrosoftGraphAppRoleAssignment[]>]:授與此服務主體授與另一個應用程式或服務的應用程式角色指派。 支援$expand。
    • [AppRoleAssignmentRequired <Boolean?>]:指定使用者或其他服務主體是否需要為此服務主體授與應用程式角色指派,使用者才能登入,或應用程式可以取得令牌。 預設值為 false。 不可為 Null。 支援$filter(eq、ne、NOT)。
    • [ClaimsMappingPolicy <IMicrosoftGraphClaimsMappingPolicy[]>]:指派給此服務主體的 claimsMappingPolicies。 支援$expand。
      • [AppliesTo <IMicrosoftGraphDirectoryObject[]>]
      • [Definition <String[]>]:字串集合,包含定義原則規則和設定的 JSON 字串。 定義語法會因每個衍生原則類型而有所不同。 必要。
      • [IsOrganizationDefault <Boolean?>]:如果設定為 true,則會啟用此原則。 相同原則類型可以有許多原則,但只有一個原則可以啟用為組織預設值。 選擇性的預設值為 false。
      • [Description <String>]:此原則的描述。
      • [DeletedDateTime <DateTime?>]
      • [DisplayName <String>]:在目錄中顯示的名稱
    • [DelegatedPermissionClassification <IMicrosoftGraphDelegatedPermissionClassification[]>]:此服務主體所代表之應用程式所公開之委派許可權的許可權分類。 支援$expand。
      • [Classification <String>]:permissionClassificationType
      • [PermissionId <String>]:servicePrincipal 之 publishedPermissionScopes 集合中所列之委派許可權的唯一標識符(id)。 建立時的必要專案。 不支援$filter。
      • [PermissionName <String>]:servicePrincipal 之 publishedPermissionScopes 集合中所列之委派許可權的宣告值(value)。 不支援$filter。
    • [Description <String>]:免費文字欄位,以提供服務主體的內部使用者面向描述。 這類 MyApps 的終端使用者入口網站將會在此欄位中顯示應用程式描述。 允許的大小上限為 1024 個字元。 支援$filter(eq、ne、NOT、ge、le、startsWith)和$search。
    • [DisabledByMicrosoftStatus <String>]:指定 Microsoft 是否已停用已註冊的應用程式。 可能的值為:null(預設值)、NotDisabled 和 DisabledDueToViolationOfServicesAgreement(原因可能包括可疑、濫用或惡意活動,或違反 Microsoft 服務合約)。 支援$filter(eq、ne、NOT)。
    • [Endpoint <IMicrosoftGraphEndpoint[]>]:可供探索的端點。 Sharepoint 之類的服務會將此屬性填入租使用者特定的 SharePoint 端點,讓其他應用程式可以在其體驗中探索及使用。
      • [DeletedDateTime <DateTime?>]
      • [DisplayName <String>]:在目錄中顯示的名稱
    • [FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential[]>]
    • [HomeRealmDiscoveryPolicy <IMicrosoftGraphHomeRealmDiscoveryPolicy[]>]:指派給此服務主體的 homeRealmDiscoveryPolicies。 支援$expand。
    • [Homepage <String>]:應用程式的首頁或登陸頁面。
    • [Info <IMicrosoftGraphInformationalUrl>]:informationalUrl
    • [KeyCredentials <IMicrosoftGraphKeyCredential[]>]:與服務主體相關聯的密鑰認證集合。 不可為 Null。 支援$filter(eq、NOT、ge、le)。
    • [LoginUrl <String>]:指定服務提供者將使用者重新導向至 Microsoft Entra ID 進行驗證的 URL。 Microsoft Entra ID 會使用 URL 從 Microsoft 365 或 Microsoft Entra 我的應用程式 啟動應用程式。 當空白時,Microsoft Entra ID 會針對以 SAML 為基礎的單一登錄所設定的應用程式執行 IdP 起始的登入。 使用者會從 Microsoft 365、Microsoft Entra 我的應用程式 或 Microsoft Entra SSO URL 啟動應用程式。
    • [LogoutUrl <String>]:指定 Microsoft 授權服務將使用的 URL,以使用 OpenId 連線 前端通道、後端通道或 SAML 註銷通訊協定來註銷使用者。
    • [Note <String>]:用來擷取服務主體相關信息的免費文字欄位,通常用於操作用途。 允許的大小上限為 1024 個字元。
    • [NotificationEmailAddress <String[]>]:指定當使用中憑證接近到期日時,Microsoft Entra ID 傳送通知的電子郵件地址清單。 這隻適用於用來簽署針對 Microsoft Entra Gallery 應用程式發行之 SAML 令牌的憑證。
    • [Oauth2PermissionScope <IMicrosoftGraphPermissionScope[]>]:應用程式公開的委派許可權。 如需詳細資訊,請參閱應用程式實體 API 屬性上的 oauth2PermissionScopes 屬性。 不可為 Null。
    • [PasswordCredentials <IMicrosoftGraphPasswordCredential[]>]:與服務主體相關聯的密碼認證集合。 不可為 Null。
    • [PreferredSingleSignOnMode <String>]:指定為此應用程式設定的單一登錄模式。 Microsoft Entra ID 會使用慣用的單一登錄模式,從 Microsoft 365 或 Microsoft Entra 我的應用程式 啟動應用程式。 支援的值為 password、saml、notSupported 和 oidc。
    • [PreferredTokenSigningKeyThumbprint <String>]:保留供內部使用。 請勿寫入或依賴這個屬性。 未來版本可能會移除。
    • [ReplyUrl <String[]>]:使用者令牌要傳送至 的 URL,以便與相關聯的應用程式登入,或將 OAuth 2.0 授權碼和存取令牌傳送至的重新導向 URI,以供相關聯的應用程式使用。 不可為 Null。
    • [SamlSingleSignOnSetting <IMicrosoftGraphSamlSingleSignOnSettings>]:samlSingleSignOn 設定
      • [(Any) <Object>]:這表示任何屬性都可以新增至這個物件。
      • [RelayState <String>]:服務提供者在完成單一登錄流程之後,會重新導向至的相對URI。
    • [ServicePrincipalName <String[]>]:包含從相關聯應用程式複製的identifiersUris清單。 您可以將其他值新增至混合式應用程式。 這些值可用來識別此應用程式在 Microsoft Entra ID 中公開的許可權。 例如,用戶端應用程式可以根據此屬性的值來指定資源 URI,以取得存取令牌,這是 『aud』 宣告中傳回的 URI。在多重值屬性上篩選表達式需要任何運算元。 不可為 Null。 支援$filter(eq、NOT、ge、le、startsWith)。
    • [ServicePrincipalType <String>]:識別服務主體是否代表應用程式或受控識別。 這是由 Microsoft Entra ID 在內部設定。 對於代表應用程式的服務主體,這會設定為Application。 對於代表受控識別的服務主體,這會設定為 ManagedIdentity。
    • [Tag <String[]>]:可用來分類和識別服務主體的自定義字串。 不可為 Null。 支援$filter(eq、NOT、ge、le、startsWith)。
    • [TokenEncryptionKeyId <String>]:從 keyCredentials 集合指定公鑰的 keyId。 設定時,Microsoft Entra ID 會使用此屬性所指定的密鑰來發行此應用程式的令牌。 接收加密令牌的應用程式程式代碼必須使用相符的私鑰來解密令牌,才能用於登入的使用者。
    • [TokenIssuancePolicy <IMicrosoftGraphTokenIssuancePolicy[]>]:指派給此服務主體的 tokenIssuancePolicies。 支援$expand。
    • [TokenLifetimePolicy <IMicrosoftGraphTokenLifetimePolicy[]>]:指派給此服務主體的 TokenLifetimePolicies。 支援$expand。
    • [TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]
    • [AppRoleId <String>]:指派給主體之應用程式角色的標識碼 (id)。 此應用程式角色必須在資源應用程式服務主體 (resourceId) 的 appRoles 屬性中公開。 如果資源應用程式未宣告任何應用程式角色,則可以指定默認應用程式角色標識碼 00000000-0000-0000-0000000000000,以發出主體指派給資源應用程式,而不需要任何特定應用程式角色。 建立時的必要專案。
    • [CreatedDateTime <DateTime?>]:建立應用程式角色指派的時間。Timestamp 類型代表使用 ISO 8601 格式的日期和時間資訊,且一律為 UTC 時間。 例如,2014 年 1 月 1 日午夜 UTC 是 2014-01-01T00:00:00Z。 唯讀。
    • [PrincipalDisplayName <String>]:授與應用程式角色指派之使用者、群組或服務主體的顯示名稱。 唯讀。 支援$filter(eq 和 startswith)。
    • [PrincipalId <String>]:授與應用程式角色之使用者、群組或服務主體的唯一標識碼(id)。 建立時的必要專案。
    • [PrincipalType <String>]:指派主體的類型。 這可以是 User、Group 或 ServicePrincipal。 唯讀。
    • [ResourceDisplayName <String>]:進行指派之資源應用程式服務主體的顯示名稱。
    • [ResourceId <String>]:進行指派之資源服務主體的唯一標識碼(id)。 建立時的必要專案。 支援$filter(僅限 eq)。
    • [AppRoleAssignment <IMicrosoftGraphAppRoleAssignmentAutoGenerated[]>]:代表已為應用程式授與群組的應用程式角色。 支援$expand。
      • [DeletedDateTime <DateTime?>]
      • [DisplayName <String>]:在目錄中顯示的名稱
      • [AppRoleId <String>]:指派給主體之應用程式角色的標識碼 (id)。 此應用程式角色必須在資源應用程式服務主體 (resourceId) 的 appRoles 屬性中公開。 如果資源應用程式未宣告任何應用程式角色,則可以指定默認應用程式角色標識碼 00000000-0000-0000-0000000000000,以發出主體指派給資源應用程式,而不需要任何特定應用程式角色。 建立時的必要專案。
      • [CreatedDateTime <DateTime?>]:建立應用程式角色指派的時間。Timestamp 類型代表使用 ISO 8601 格式的日期和時間資訊,且一律為 UTC 時間。 例如,2014 年 1 月 1 日午夜 UTC 是 2014-01-01T00:00:00Z。 唯讀。
      • [PrincipalDisplayName <String>]:授與應用程式角色指派之使用者、群組或服務主體的顯示名稱。 唯讀。 支援$filter(eq 和 startswith)。
      • [PrincipalId <String>]:授與應用程式角色之使用者、群組或服務主體的唯一標識碼(id)。 建立時的必要專案。
      • [PrincipalType <String>]:指派主體的類型。 這可以是 User、Group 或 ServicePrincipal。 唯讀。
      • [ResourceDisplayName <String>]:進行指派之資源應用程式服務主體的顯示名稱。
      • [ResourceId <String>]:進行指派之資源服務主體的唯一標識碼(id)。 建立時的必要專案。 支援$filter(僅限 eq)。
    • [Classification <String>]:描述群組的分類(例如低、中或高業務影響)。 根據範本定義建立 ClassificationList 設定值,可定義此屬性的有效值。預設會傳回 。 支援$filter(eq、ne、NOT、ge、le、startsWith)。
    • [CreatedOnBehalfOf <IMicrosoftGraphDirectoryObject>]:代表 Microsoft Entra 物件。 directoryObject 類型是許多其他目錄實體類型的基底類型。
    • [Description <String>]:群組的選擇性描述。 預設會傳回 。 支援$filter(eq、ne、NOT、ge、le、startsWith)和$search。
    • [GroupType <String[]>]:指定群組類型及其成員資格。 如果集合包含 Unified,則此群組為 Microsoft 365 群組;否則為安全組或通訊群組。 如需詳細資訊,請參閱群組概觀。如果集合包含 DynamicMembership,則群組具有動態成員資格;否則,成員資格是靜態的。 預設會傳回 。 支援$filter (eq, NOT)。
    • [HasMembersWithLicenseError <Boolean?>]:指出此群組中是否有成員在其群組型授權指派中發生授權錯誤。 在 GET 作業上永遠不會傳回這個屬性。 您可以使用它作為$filter自變數來取得具有授權錯誤成員的群組(也就是篩選此屬性為 true)。 支援$filter (eq)。
    • [IsArchived <Boolean?>]
    • [IsAssignableToRole <Boolean?>]:指出是否可以將此群組指派給 Microsoft Entra 角色。這個屬性只能在建立群組時設定,而且是不可變的。 如果設定為 true,securityEnabled 屬性也必須設定為 true,而且群組不能是動態群組(也就是 groupTypes 不能包含 DynamicMembership)。 只有全域管理員和特殊許可權角色管理員角色中的呼叫端可以設定此屬性。 呼叫端也必須獲指派 Directory.AccessAsUser.All 許可權,才能設定此屬性。 如需詳細資訊,請參閱使用群組來管理預設的 Microsoft Entra 角色指派。 支援$filter(eq、ne、NOT)。
    • [MailEnabled <Boolean?>]:指定群組是否啟用郵件功能。 預設會傳回 。 支援$filter(eq、ne、NOT)。
    • [MailNickname <String>]:群組的郵件別名,在組織中是唯一的。 建立群組時必須指定這個屬性。 這些字元不能用於 mailNickName: @()/[]';:.<>,SPACE。 預設會傳回 。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。
    • [MembershipRule <String>]:如果群組是動態群組,則決定此群組成員的規則(groupTypes 包含 DynamicMembership)。 如需成員資格規則語法的詳細資訊,請參閱成員資格規則語法。 預設會傳回 。 支援$filter(eq、ne、NOT、ge、le、startsWith)。
    • [MembershipRuleProcessingState <String>]:指出動態成員資格處理是否開啟或暫停。 可能的值為 On 或 Paused。 預設會傳回 。 支援 $filter (eq, ne, NOT, in) 。
    • [PermissionGrant <IMicrosoftGraphResourceSpecificPermissionGrant[]>]:已為群組授與給特定應用程式的許可權。 支援$expand。
      • [DeletedDateTime <DateTime?>]
      • [DisplayName <String>]:在目錄中顯示的名稱
      • [ClientAppId <String>]:已授與存取權之 Microsoft Entra 應用程式的服務主體標識碼。 唯讀。
      • [ClientId <String>]:已授與存取權的 Microsoft Entra 應用程式識別碼。 唯讀。
      • [Permission <String>]:資源特定許可權的名稱。 唯讀。
      • [PermissionType <String>]:許可權的類型。 可能的值為:應用程式、委派。 唯讀。
      • [ResourceAppId <String>]:裝載資源的 Microsoft Entra 應用程式識別碼。 唯讀。
    • [PreferredDataLocation <String>]:群組的慣用數據位置。 如需詳細資訊,請參閱 OneDrive Online 多地理位置。 預設會傳回 。
    • [PreferredLanguage <String>]:Microsoft 365 群組慣用的語言。 應遵循 ISO 639-1 程式代碼;例如 『en-US』。 預設會傳回 。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。
    • [SecurityEnabled <Boolean?>]:指定群組是否為安全組。 預設會傳回 。 支援 $filter (eq, ne, NOT, in) 。
    • [SecurityIdentifier <String>]:在 Windows 案例中使用的群組安全性識別碼。 預設會傳回 。
    • [Theme <String>]:指定 Microsoft 365 群組的色彩主題。 可能的值為 Teal、紫色、綠色、藍色、粉紅、橙色或紅色。 預設會傳回 。
    • [Visibility <String>]:指定群組的組策略和群組內容可見度。 可能的值為:Private、Public 或 Hiddenmembership。 建立群組時,只能針對 Microsoft 365 群組設定 Hiddenmembership。 稍後無法更新。 群組建立之後,可以更新其他可見度值。 如果在 Microsoft Graph 的群組建立期間未指定可見度值,安全組預設會建立為 Private,且 Microsoft 365 群組為 Public。 若要深入瞭解,請參閱群組可見度選項。 預設會傳回 。
    • [ClientAppId <String>]:已授與存取權之 Microsoft Entra 應用程式的服務主體標識碼。 唯讀。
    • [ClientId <String>]:已授與存取權的 Microsoft Entra 應用程式識別碼。 唯讀。
    • [Permission <String>]:資源特定許可權的名稱。 唯讀。
    • [PermissionType <String>]:許可權的類型。 可能的值為:應用程式、委派。 唯讀。
    • [ResourceAppId <String>]:裝載資源的 Microsoft Entra 應用程式識別碼。 唯讀。
    • [AccountEnabled <Boolean?>]:如果帳戶已啟用,則為 true;否則為 false。 建立使用者時需要這個屬性。 支援$filter(eq、ne、NOT 和 in)。
    • [AgeGroup <String>]:設定使用者的年齡群組。 允許的值:null、minor、notAdult 和成人。 如需進一步資訊,請參閱法律年齡群組屬性定義。 支援$filter(eq、ne、NOT 和 in)。
    • [ApproximateLastSignInDateTime <DateTime?>]:時間戳類型代表使用 ISO 8601 格式的日期和時間資訊,且一律為 UTC 時間。 例如,2014 年 1 月 1 日午夜 UTC 是 2014-01-01T00:00:00Z。 唯讀。 支援$filter(eq、ne、not、ge、le 和 eq on null 值)和 $orderBy。
    • [City <String>]:使用者所在的城市。 長度上限為 128 個字元。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。
    • [CompanyName <String>]:使用者相關聯的公司名稱。 此屬性對於描述外部使用者所來自的公司很有用。 公司名稱的最大長度為64個字元。支援$filter(eq、ne、NOT、ge、le、in、startsWith)。
    • [ComplianceExpirationDateTime <DateTime?>]:裝置不再被視為符合規範時的時間戳。 時間戳類型代表使用 ISO 8601 格式的日期和時間資訊,且一律為 UTC 時間。 例如,2014 年 1 月 1 日午夜 UTC 是 2014-01-01T00:00:00Z。 唯讀。
    • [ConsentProvidedForMinor <String>]:設定是否已取得未成年人的同意。 允許的值:Null、授與、拒絕和 notRequired。 如需進一步資訊,請參閱法律年齡群組屬性定義。 支援$filter(eq、ne、NOT 和 in)。
    • [Country <String>]:使用者所在的國家/地區;例如,美國或英國。 長度上限為 128 個字元。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。
    • [Department <String>]:用戶運作所在的部門名稱。 最大長度為64個字元。支援$filter(eq、ne、NOT、ge、le 和 in 運算符)。
    • [DeviceVersion <Int32?>]:僅供內部使用。
    • [EmployeeHireDate <DateTime?>]:僱用使用者的日期和時間,或在未來僱用時開始工作。 支援$filter (eq, ne, NOT , ge, le, in) 。
    • [EmployeeId <String>]:組織指派給使用者的員工標識符。 支援$filter (eq, ne, NOT , ge, le, in, startsWith) 。
    • [EmployeeOrgData <IMicrosoftGraphEmployeeOrgData>]:employeeOrgData
    • [EmployeeType <String>]:擷取企業背景工作角色類型。 例如,員工、承包商、顧問或廠商。 支援$filter (eq, ne, NOT , ge, le, in, startsWith) 。
    • [ExternalUserState <String>]:對於使用邀請 API 邀請給租使用者的外部使用者,此屬性代表受邀使用者的邀請狀態。 對於受邀的用戶,狀態可以是PendingAcceptance或 Accepted,或所有其他使用者的 Null。 支援 $filter (eq, ne, NOT , in) 。
    • [ExternalUserStateChangeDateTime <DateTime?>]:顯示 externalUserState 屬性最新變更的時間戳。 支援 $filter (eq, ne, NOT , in) 。
    • [FaxNumber <String>]:用戶的傳真號。 支援$filter (eq, ne, NOT , ge, le, in, startsWith) 。
    • [GivenName <String>]:使用者的指定名稱(名字)。 最大長度為64個字元。 支援$filter (eq, ne, NOT , ge, le, in, startsWith) 。
    • [Identity <IMicrosoftGraphObjectIdentity[]>]:表示可用來登入此用戶帳戶的身分識別。 身分識別可由 Microsoft 提供(也稱為本機帳戶)、組織或社交識別提供者,例如 Facebook、Google 和 Microsoft,以及系結至用戶帳戶。 可能包含多個具有相同 signInType 值的專案。 僅支援 signInType 不是 userPrincipalName 的 $filter (eq)。
    • [IsResourceAccount <Boolean?>]:請勿使用 - 保留供日後使用。
    • [JobTitle <String>]:用戶的職稱。 長度上限為 128 個字元。 支援$filter (eq, ne, NOT , ge, le, in, startsWith) 。
    • [Mail <String>]:使用者的 SMTP 位址, admin@contoso.com例如 。 此屬性的變更也會更新使用者的 proxyAddresses 集合,以將值納入 SMTP 位址。 雖然這個屬性可以包含輔色字元,但使用這些字元可能會對使用者的其他 Microsoft 應用程式造成存取問題。 支援$filter(eq、ne、NOT、ge、le、in、startsWith、endsWith)。
    • [MailNickname <String>]:使用者的郵件別名。 建立使用者時,必須指定這個屬性。 最大長度為64個字元。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。
    • [Manager <IMicrosoftGraphDirectoryObject>]:代表 Microsoft Entra 物件。 directoryObject 類型是許多其他目錄實體類型的基底類型。
    • [OfficeLocation <String>]:使用者營業地點的辦公室位置。 長度上限為 128 個字元。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。
    • [OnPremisesImmutableId <String>]:這個屬性可用來將 內部部署的 Active Directory 用戶帳戶與其 Microsoft Entra 使用者對象產生關聯。 如果您使用使用者 userPrincipalName (UPN) 屬性的同盟網域,則必須在 Graph 中建立新的使用者帳戶時指定此屬性。 注意:指定這個屬性時,無法使用 $ 和 _ 字元。 只在$select傳回。 支援$filter(eq、ne、NOT、ge、le、in)。
    • [OnPremisesLastSyncDateTime <DateTime?>]:物件上次與內部部署目錄同步的時間。 Timestamp 類型代表使用 ISO 8601 格式的日期和時間資訊,且一律為 UTC 時間。 例如,2014 年 1 月 1 日午夜 UTC 為 2014-01-01T00:00:00Z 只讀。 支援$filter (eq, ne, not, ge, le, in) 。
    • [OnPremisesSyncEnabled <Boolean?>]:如果此對像是從內部部署目錄同步處理,則為 true;如果此物件原本是從內部部署目錄同步處理,但不再同步,則為 false;如果從未從內部部署目錄同步處理此物件,則為 null (預設值)。 唯讀。 支援$filter (eq、ne、not、in 和 eq on null 值)。
    • [OperatingSystem <String>]:裝置的作業系統。 Windows、iOS 等這個屬性是唯讀的。
    • [OperatingSystemVersion <String>]:裝置的操作系統版本。 必要。 支援$filter (eq、ne、not、ge、le、startsWith 和 eq on null 值)。
    • [OtherMail <String[]>]:使用者的其他電子郵件地址清單;例如:[''bob@contoso.com,''Robert@fabrikam.com]。注意:雖然此屬性可以包含輔色字元,但它們可能會對使用者的第一方應用程式造成存取問題。支援$filter(eq、NOT、ge、le、in、startsWith)。
    • [PasswordPolicy <String>]:指定使用者的密碼原則。 這個值是列舉,其中一個可能值為 DisableStrongPassword,允許比指定預設原則更弱的密碼。 您也可以指定 DisablePasswordExpiration。 兩者可以一起指定;例如:DisablePasswordExpiration、DisableStrongPassword.Supports $filter (ne, NOT)。
    • [PasswordProfile <IMicrosoftGraphPasswordProfile>]:passwordProfile
      • [(Any) <Object>]:這表示任何屬性都可以新增至這個物件。
      • [ForceChangePasswordNextSignIn <Boolean?>]:如果用戶必須在下一次登入時變更密碼,則為 true;否則為 false。 如果未設定,預設值為 false。 注意:對於 Azure B2C 租使用者,請設定為 false,並改為使用自定義原則和使用者流程,強制在初次登入時重設密碼。 請參閱在第一次登入時強制重設密碼。
      • [ForceChangePasswordNextSignInWithMfa <Boolean?>]:如果為 true,在下一次登入時,用戶必須先執行多重要素驗證 (MFA),才能強制變更其密碼。 此行為與 forceChangePasswordNextSignIn 相同,不同之處在於用戶必須先在密碼變更之前執行多重要素驗證。 密碼變更之後,此屬性會自動重設為 false。 如果未設定,預設值為 false。
      • [Password <String>]:用戶的密碼。 建立使用者時需要這個屬性。 它可以更新,但用戶必須變更下一次登入的密碼。 密碼必須符合使用者passwordPolicies屬性所指定的最低需求。 根據預設,需要強密碼。
    • [PhysicalId <String[]>]:僅供內部使用。 不可為 Null。 支援$filter (eq, not, ge, le, startsWith)。
    • [PostalCode <String>]:用戶郵政地址的郵遞區號。 郵遞區編碼專屬於用戶的國家/地區。 在美國的 美國 中,此屬性包含郵遞郵遞編碼。 最大長度為 40 個字元。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。
    • [PreferredLanguage <String>]:使用者慣用的語言。 應遵循 ISO 639-1 程式代碼;例如 en-US。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。
    • [ShowInAddressList <Boolean?>]:如果 Outlook 全域通訊清單應該包含此使用者,則為 true,否則為 false。 如果未設定,則會將此視為 true。 對於透過邀請管理員邀請的使用者,此屬性會設定為 false。 支援 $filter (eq, ne, NOT, in) 。
    • [State <String>]:用戶位址中的州或省。 長度上限為 128 個字元。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。
    • [StreetAddress <String>]:使用者營業地點的街道位址。 長度上限是 1024 個字元。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。
    • [Surname <String>]:使用者的姓氏(姓氏或姓氏)。 最大長度為64個字元。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。
    • [TrustType <String>]:已加入裝置的信任類型。 唯讀。 可能的值:Workplace(表示攜帶您自己的個人裝置)、AzureAd(僅限已加入雲端的裝置)、ServerAd(已加入內部部署網域的裝置已加入 Microsoft Entra ID)。 如需詳細資訊,請參閱 Microsoft Entra ID 中的裝置管理簡介
    • [UsageLocation <String>]:兩個字母國家/地區代碼(ISO 標準 3166)。 由於法律要求檢查國家/地區服務可用性,因此需要指派授權的使用者。 範例包括:US、JP 和 GB。 不可為 Null。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。
    • [UserPrincipalName <String>]:使用者的用戶主體名稱(UPN)。 UPN 是以因特網標準 RFC 822 為基礎的使用者因特網樣式登入名稱。 依照慣例,這應該對應至使用者的電子郵件名稱。 一般格式是alias@domain,其中網域必須存在於租使用者的已驗證網域集合中。 建立使用者時需要這個屬性。 您可以從組織的 verifiedDomains 屬性存取租使用者的已驗證網域。注意:雖然此屬性可以包含輔色字元,但它們可能會對使用者的第一方應用程式造成存取問題。 支援$filter(eq、ne、NOT、ge、le、in、startsWith、endsWith) 和 $orderBy。
    • [UserType <String>]:字串值,可用來分類目錄中的用戶類型,例如 Member 和 Guest。 支援$filter (eq, ne, NOT, in, in, ) 。
  • [OfficeLocation <String>]:使用者營業地點的辦公室位置。 長度上限為 128 個字元。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。
  • [OnPremisesImmutableId <String>]:這個屬性可用來將 內部部署的 Active Directory 用戶帳戶與其 Microsoft Entra 使用者對象產生關聯。 如果您使用使用者 userPrincipalName (UPN) 屬性的同盟網域,則必須在 Graph 中建立新的使用者帳戶時指定此屬性。 注意:指定這個屬性時,無法使用 $ 和 _ 字元。 只在$select傳回。 支援$filter(eq、ne、NOT、ge、le、in)。
  • [OnPremisesLastSyncDateTime <DateTime?>]:物件上次與內部部署目錄同步的時間。 Timestamp 類型代表使用 ISO 8601 格式的日期和時間資訊,且一律為 UTC 時間。 例如,2014 年 1 月 1 日午夜 UTC 為 2014-01-01T00:00:00Z 只讀。 支援$filter (eq, ne, not, ge, le, in) 。
  • [OnPremisesSyncEnabled <Boolean?>]:如果此對像是從內部部署目錄同步處理,則為 true;如果此物件原本是從內部部署目錄同步處理,但不再同步,則為 false;如果從未從內部部署目錄同步處理此物件,則為 null (預設值)。 唯讀。 支援$filter (eq、ne、not、in 和 eq on null 值)。
  • [OperatingSystem <String>]:裝置的作業系統。 Windows、iOS 等這個屬性是唯讀的。
  • [OperatingSystemVersion <String>]:裝置的操作系統版本。 必要。 支援$filter (eq、ne、not、ge、le、startsWith 和 eq on null 值)。
  • [OtherMail <String[]>]:使用者的其他電子郵件地址清單;例如:[''bob@contoso.com,''Robert@fabrikam.com]。注意:雖然此屬性可以包含輔色字元,但它們可能會對使用者的第一方應用程式造成存取問題。支援$filter(eq、NOT、ge、le、in、startsWith)。
  • [PasswordPolicy <String>]:指定使用者的密碼原則。 這個值是列舉,其中一個可能值為 DisableStrongPassword,允許比指定預設原則更弱的密碼。 您也可以指定 DisablePasswordExpiration。 兩者可以一起指定;例如:DisablePasswordExpiration、DisableStrongPassword.Supports $filter (ne, NOT)。
  • [PasswordProfile <IMicrosoftGraphPasswordProfile>]:passwordProfile
  • [PhysicalId <String[]>]:僅供內部使用。 不可為 Null。 支援$filter (eq, not, ge, le, startsWith)。
  • [PostalCode <String>]:用戶郵政地址的郵遞區號。 郵遞區編碼專屬於用戶的國家/地區。 在美國的 美國 中,此屬性包含郵遞郵遞編碼。 最大長度為 40 個字元。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。
  • [PreferredLanguage <String>]:使用者慣用的語言。 應遵循 ISO 639-1 程式代碼;例如 en-US。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。
  • [ShowInAddressList <Boolean?>]:如果 Outlook 全域通訊清單應該包含此使用者,則為 true,否則為 false。 如果未設定,則會將此視為 true。 對於透過邀請管理員邀請的使用者,此屬性會設定為 false。 支援 $filter (eq, ne, NOT, in) 。
  • [State <String>]:用戶位址中的州或省。 長度上限為 128 個字元。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。
  • [StreetAddress <String>]:使用者營業地點的街道位址。 長度上限是 1024 個字元。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。
  • [Surname <String>]:使用者的姓氏(姓氏或姓氏)。 最大長度為64個字元。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。
  • [TrustType <String>]:已加入裝置的信任類型。 唯讀。 可能的值:Workplace(表示攜帶您自己的個人裝置)、AzureAd(僅限已加入雲端的裝置)、ServerAd(已加入內部部署網域的裝置已加入 Microsoft Entra ID)。 如需詳細資訊,請參閱 Microsoft Entra ID 中的裝置管理簡介
  • [UsageLocation <String>]:兩個字母國家/地區代碼(ISO 標準 3166)。 由於法律要求檢查國家/地區服務可用性,因此需要指派授權的使用者。 範例包括:US、JP 和 GB。 不可為 Null。 支援$filter(eq、ne、NOT、ge、le、in、startsWith)。
  • [UserPrincipalName <String>]:使用者的用戶主體名稱(UPN)。 UPN 是以因特網標準 RFC 822 為基礎的使用者因特網樣式登入名稱。 依照慣例,這應該對應至使用者的電子郵件名稱。 一般格式是alias@domain,其中網域必須存在於租使用者的已驗證網域集合中。 建立使用者時需要這個屬性。 您可以從組織的 verifiedDomains 屬性存取租使用者的已驗證網域。注意:雖然此屬性可以包含輔色字元,但它們可能會對使用者的第一方應用程式造成存取問題。 支援$filter(eq、ne、NOT、ge、le、in、startsWith、endsWith) 和 $orderBy。
  • [UserType <String>]:字串值,可用來分類目錄中的用戶類型,例如 Member 和 Guest。 支援$filter (eq, ne, NOT, in, in, ) 。

PASSWORDPROFILE <IMicrosoftGraphPasswordProfile>:passwordProfile

  • [(Any) <Object>]:這表示任何屬性都可以新增至這個物件。
  • [ForceChangePasswordNextSignIn <Boolean?>]:如果用戶必須在下一次登入時變更密碼,則為 true;否則為 false。 如果未設定,預設值為 false。 注意:對於 Azure B2C 租使用者,請設定為 false,並改為使用自定義原則和使用者流程,強制在初次登入時重設密碼。 請參閱在第一次登入時強制重設密碼。
  • [ForceChangePasswordNextSignInWithMfa <Boolean?>]:如果為 true,在下一次登入時,用戶必須先執行多重要素驗證 (MFA),才能強制變更其密碼。 此行為與 forceChangePasswordNextSignIn 相同,不同之處在於用戶必須先在密碼變更之前執行多重要素驗證。 密碼變更之後,此屬性會自動重設為 false。 如果未設定,預設值為 false。
  • [Password <String>]:用戶的密碼。 建立使用者時需要這個屬性。 它可以更新,但用戶必須變更下一次登入的密碼。 密碼必須符合使用者passwordPolicies屬性所指定的最低需求。 根據預設,需要強密碼。