實體和複雜類型參考 | Graph API 參考
**適用於︰**Graph API | Azure Active Directory
Graph API 是 OData 3.0 相容的 REST API,可讓您以程式設計方式存取 Azure Active Directory 中的目錄物件,例如使用者、群組、組織連絡人和應用程式。
重要
您也可以透過 Microsoft Graph 取得 Azure AD Graph API 功能,這個統一 API 同時也包含如 Outlook、OneDrive、OneNote、Planner 和 Office Graph 等其他 Microsoft 服務 API,讓您可以使用單一的存取權杖透過單一端點存取所有 API。
實體參考
應用程式實體
代表應用程式。 將驗證工作委外給 Azure AD 的任何應用程式必須在目錄中註冊。 這涉及向 Azure AD 說明您的應用程式,包括它所在的 URL、驗證之後傳送回覆的 URL、用來識別應用程式的 URI 等。 如需詳細資訊,請參閱在 Azure AD 中註冊應用程式的基本概念。 繼承自 DirectoryObject。
屬性
宣告屬性
Name | 類型 | 支援 | 說明 |
---|---|---|---|
addIns | Collection(AddIn) | POST, GET, PATCH | 定義取用服務可用來在特定內容中呼叫應用程式的自訂行為。 例如,可以轉譯檔案資料流的應用程式可能會為其 "FileHandler" 功能設定 addIns 屬性。 這可讓如 Office 365 等服務在使用者目前正在處理的文件內容中呼叫應用程式。 注意:需要 1.6 版。 |
appId | 1.5 版中為 Edm.String 舊版中為 Edm.Guid |
GET ($filter) | 應用程式的唯一識別碼。 |
appRoles | Collection(AppRole) | POST, GET, PATCH | 應用程式可以宣告的應用程式角色的集合。 這些角色可以指派給使用者、群組或服務主體。 注意︰需要 1.5 版,不可為 Null。 |
availableToOtherTenants | Edm.Boolean | POST, GET ($filter), PATCH | 若與其他租用戶共用應用程式,則為 true;否則為 false。 |
deletionTimestamp | Edm.DateTime | GET | 從租用戶刪除應用程式的時間。 如果應用程式尚未刪除,就會傳回 null。 已刪除的應用程式可以從 /deletedApplications 資源集合讀取。 繼承自 DirectoryObject。注意:需要 1.5 版或更新版本。 |
displayName | Edm.String | POST (必要), GET, PATCH | 應用程式的顯示名稱。 |
errorUrl | Edm.String | POST, GET, PATCH | |
groupMembershipClaims | Edm.String | POST, GET, PATCH | 位元遮罩,用來設定應用程式預期的使用者或 OAuth 2.0 存取權杖中發出的「群組」宣告。 位元遮罩值如下︰0︰無;1︰安全性群組和 Azure AD 角色;2︰已保留;4︰已保留。 將位元遮罩設為 7 可取得登入之使用者所屬的所有安全性群組、通訊群組和 Azure AD 目錄角色。 注意:需要 1.5 版。 |
首頁 | Edm.String | POST, GET, PATCH | 應用程式首頁的 URL。 |
identifierUris | Collection(Edm.String) | POST, GET ($filter), PATCH | 識別應用程式的 URI。 如需詳細資訊,請參閱應用程式物件和服務主體物件。 注意︰不可為 Null,多重值屬性的篩選條件運算式需要 any 運算子;如需詳細資訊,請參閱Supported Queries, Filters, and Paging Options。 |
keyCredentials | Collection(KeyCredential) | POST, GET, PATCH | 與應用程式相關聯的金鑰認證集合 注意:不可為 Null |
knownClientApplications | Collection(Edm.Guid) | POST, GET, PATCH | 繫結至這個資源應用程式的用戶端應用程式。 同意任何已知的用戶端應用程式會導致透過結合的同意對話方塊 (顯示用戶端和資源所需的 OAuth 權限範圍),隱含地同意資源應用程式。 注意︰需要 1.5 版,不可為 Null。 |
logoutUrl | Edm.String | POST, GET, PATCH | |
mainLogo | Edm.Stream | POST, GET, PATCH | 應用程式的主要標誌。 注意:不可為 Null |
oauth2AllowImplicitFlow | Edm.Boolean | POST, GET, PATCH | 指定此 Web 應用程式是否可以要求 OAuth2.0 隱含流程權杖。 預設值為 false。 注意︰需要 1.5 版,不可為 Null。 |
oauth2AllowUrlPathMatching | Edm.Boolean | POST, GET, PATCH | 在 OAuth 2.0 權杖要求中,指定 Azure AD 是否允許根據應用程式的 replyUrls 來比對重新導向 URI 的路徑。 預設值為 false。 注意︰需要 1.5 版,不可為 Null。 |
oauth2Permissions | Collection(OAuth2Permission) | POST, GET, PATCH | Web API (資源) 應用程式公開給用戶端應用程式的 OAuth 2.0 權限範圍的集合。 這些權限範圍可以在同意期間授與用戶端應用程式。 注意︰需要 1.5 版,不可為 Null。 |
oauth2RequiredPostResponse | Edm.Guid | POST, GET, PATCH | 在 OAuth 2.0 權杖要求中,指定 Azure AD 是否允許 POST 要求,而不是 GET 要求。 預設值是 false,指定只允許 GET 要求。 注意︰需要 1.5 版,不可為 Null。 |
objectId | Edm.Guid | GET | 應用程式的唯一識別碼。 繼承自 DirectoryObject。 注意:索引鍵、不可變、不可為 Null、唯一 |
objectType | Edm.String | GET | 識別此物件類型的字串。 對於應用程式,這個值一律是 "Application"。 繼承自 DirectoryObject。 |
passwordCredentials | Collection(PasswordCredential) | POST, GET, PATCH | 與應用程式相關聯的密碼認證集合。 注意:不可為 Null |
publicClient | Edm.Boolean | POST、GET | 指定此應用程式是否為公用的用戶端 (例如行動裝置上執行的已安裝應用程式)。 預設值為 false。 |
recordConsentConditions | Edm.String | GET | 請勿使用。 可能會在未來版本中移除 注意:需要 1.6 版。 |
replyUrls | Collection(Edm.String) | POST, GET, PATCH | 指定使用者權杖傳送到以登入的 URL,或 OAuth 2.0 授權碼和存取權杖傳送到的重新導向 URI。 注意:不可為 Null |
requiredResourceAccess | Collection(RequiredResourceAccess) | POST, GET, PATCH | 指定此應用程式需要存取的資源,以及它在每個資源下所需的一組 OAuth 權限範圍和應用程式角色。 這樣預先設定必要的資源存取權可決定同意體驗。 注意︰需要 1.5 版,不可為 Null。 |
samlMetadataUrl | Edm.String | POST, GET, PATCH | 應用程式 SAML 中繼資料的 URL。 |
導覽屬性
Name | 收件者 | 多重性 (來源/目的地) |
說明 |
---|---|---|---|
extensionProperties | ExtensionProperty | */* | 與應用程式相關聯的延伸模組屬性。 需要 1.5 或更新版本。 |
owners | DirectoryObject | */* | 代表應用程式擁有者的目錄物件。 擁有者是一組允許修改此物件的非系統管理員使用者。 需要 2013-11-08 版本或更新版本。 繼承自 DirectoryObject。 |
serviceEndpoints | serviceEndpoint | 1/* | 適用於探索的服務端點。 如需詳細資訊,請參閱 ServiceEndpoint 主題。 HTTP 方法︰POST、GET 和 DELETE。 需要 1.6 版或更新版本。 |
注意︰不支援未列出的繼承導覽屬性。 傳送到不支援之導覽屬性的要求會傳回「400 不正確的要求」****。
支援的作業
下列為應用程式支援的作業 (HTTP 方法位於括弧內):
- 建立 (POST)
- 讀取 (READ)
- 更新 (PATCH)
- 刪除 (DELETE)
應用程式導覽屬性支援下列作業。 並非每個導覽屬性都支援所有作業。
- 讀取 (READ)
- 更新 (POST)
- 刪除 (DELETE)
應用程式上可呼叫下列動作。
- restore 可還原已刪除的應用程式。 需要 1.5 版或更新版本。
AppRoleAssignment 實體
當使用者或群組指派給應用程式時用來記錄。 在此情況下,角色指派會導致使用者的應用程式存取面板上顯示應用程式磚。 此實體也可用來授權另一個應用程式 (模擬成服務主體) 以特定的角色存取資源應用程式。 您可以建立、讀取、更新和刪除角色指派。 繼承自 DirectoryObject。
重要:在 1.5 版中引進。
屬性
宣告屬性
Name | 類型 | 支援 | 說明 |
---|---|---|---|
creationTimestamp | Edm.DateTime | GET | 建立授權的時間。 |
deletionTimestamp | Edm.DateTime | GET | 此屬性對應用程式角色指派而言無效,一律會傳回 null。 繼承自 DirectoryObject。 注意:需要 1.5 版或更新版本。 |
id | Edm.Guid | POST (必要), GET, PATCH | 指派給主體的角色識別碼。 這個角色必須由目標資源應用程式 resourceId 在其 appRoles 屬性中宣告。 當資源未宣告任何權限時,就必須指定預設識別碼 (零 GUID)。 注意:不可為 Null。 |
principalDisplayName | Edm.String | GET | 已獲授與存取權之主體的顯示名稱。 |
objectId | Edm.String | GET | 應用程式角色指派的唯一識別碼。 繼承自 DirectoryObject。 注意:索引鍵、不可變、不可為 Null、唯一。 |
objectType | Edm.String | GET | 識別此物件類型的字串。 對於應用程式角色指派,這個值一律是 "AppRoleAssignment"。 繼承自 DirectoryObject。 |
principalId | Edm.Guid | POST (必要), GET, PATCH | 要授與存取權之主體的唯一識別碼 (objectId)。 注意:必要。 |
principalType | Edm.String | GET | 主體的類型。 這可以是 "User"、"Group" 或 "ServicePrincipal"。 |
resourceDisplayName | Edm.String | GET | 已獲指派之資源的顯示名稱。 |
resourceId | Edm.Guid | POST (必要), GET, PATCH | 已獲指派之目標資源 (服務主體) 的唯一識別碼 (objectId)。 |
導覽屬性
無。
注意︰不支援未列出的繼承導覽屬性。 傳送到不支援之導覽屬性的要求會傳回「400 不正確的要求」****。
Contact 實體
代表組織連絡人。 繼承自 DirectoryObject。
組織連絡人代表不在您公司目錄中的使用者。 他們是擁有郵件功能的實體,且通常代表公司或組織外部的個人。 您無法使用 Azure AD 驗證組織連絡人,也無法對其指派授權。
您可以透過使用 Azure AD Connect 與內部部署目錄同步處理,在您的租用戶中建立組織連絡人,或是透過 Exchange Online 管理入口網站或 Exchange Online PowerShell Cmdlet 來建立。 如需 Azure AD Connect 的詳細資訊,請參閱整合內部部署身分識別與 Azure Active Directory。 如需 Exchange Online 管理工具的詳細資訊,請參閱 Exchange Online 的安裝和管理。
您無法使用 Graph API 來建立組織連絡人。 不過,您可以更新及刪除目前不是從內部部署目錄同步處理的連絡人;也就是 dirSyncEnabled 屬性是 null 或 false 的連絡人。 您無法更新或刪除 dirSyncEnabled 屬性是 true 的連絡人。
注意︰組織連絡人是代表外部使用者的目錄實體。 它們不應該與 O365 Outlook 個人連絡人混淆。
屬性
宣告屬性
Name | 類型 | 支援 | 說明 |
---|---|---|---|
城市 | Edm.String | GET ($filter), PATCH | 連絡人所在的縣市。 |
國家/地區 | Edm.String | GET ($filter), PATCH | 連絡人所在的國家/地區。 |
deletionTimestamp | Edm.DateTime | GET | 此屬性對連絡人而言無效,一律會傳回 null。 繼承自 DirectoryObject。 注意:需要 1.5 版或更新版本。 |
department | Edm.String | GET ($filter), PATCH | 連絡人工作的部門名稱。 |
dirSyncEnabled | Edm.Boolean | GET ($filter) | 若此物件從內部部署目錄同步處理,則為 true;若此物件原本從內部部署目錄同步處理但已不再同步處理,則為 false;如果此物件從未自內部部署目錄同步處理 (預設值),則為 null。 |
displayName | Edm.String | GET ($filter), PATCH | 連絡人的顯示名稱。 |
facsimileTelephoneNumber | Edm.String | GET, PATCH | 連絡人的商務傳真機電話號碼。 |
givenName | Edm.String | GET ($filter), PATCH | 連絡人的名字。 |
jobTitle | Edm.String | GET ($filter), PATCH | 連絡人的職稱。 |
lastDirSyncTime | Edm.DateTime | GET ($filter) | 指出此物件上次與內部部署目錄進行同步處理的時間。 |
Edm.String | GET ($filter) | 連絡人的 SMTP 位址,例如 "jeff@contoso.onmicrosoft.com"。 | |
mailNickname | Edm.String | GET ($filter), PATCH | 連絡人的郵件別名。 |
行動 | Edm.String | GET, PATCH | 連絡人的主要行動電話號碼。 |
objectId | Edm.String | GET | 連絡人的唯一識別碼。 繼承自 DirectoryObject。 注意:索引鍵、不可變、不可為 Null、唯一。 |
objectType | Edm.String | GET | 識別此物件類型的字串。 對於連絡人,這個值一律是 "Contact"。 繼承自 DirectoryObject。 |
physicalDeliveryOfficeName | Edm.String | GET, PATCH | 連絡人工作地點的辦公室位置。 |
postalCode | Edm.String | GET, PATCH | 連絡人郵寄地址的郵遞區號。 郵遞區號會依連絡人的國家/地區而定。 在美國,此屬性包含了郵遞區號 (ZIP Code)。 |
provisioningErrors | Collection(ProvisioningError) | GET, PATCH | 導致無法成功佈建這名連絡人的錯誤詳細資料的集合。 注意:不可為 Null |
proxyAddresses | Collection(Edm.String) | GET ($filter) | 注意︰唯一、不可為 Null,多重值屬性的篩選條件運算式需要 any 運算子;如需詳細資訊,請參閱Supported Queries, Filters, and Paging Options。 |
sipProxyAddress | Edm.String | GET | 指定連絡人的 voice over IP (VOIP) 工作階段初始通訊協定 (SIP) 位址。 注意:需要 1.5 版或更新版本。 |
狀態 | Edm.String | GET ($filter), PATCH | 連絡人地址所屬的州/省。 |
streetAddress | Edm.String | GET, PATCH | 連絡人工作地點的街道地址。 |
surname | Edm.String | GET ($filter), PATCH | 連絡人的姓氏。 |
telephoneNumber | Edm.String | GET, PATCH | 連絡人工作地點的主要電話號碼。 |
thumbnailPhoto | Edm.Stream | GET, PATCH | 連絡人的相片縮圖顯示。 注意:不可為 Null |
導覽屬性
| Name | 收件者 | 多重性
(來源/目的地) | 說明 |
|:-----|:---|:----------------------------|:------------|
| manager | DirectoryObject
(僅支援 User 和 Contact 物件。) | /0..1 | 擔任這名連絡人管理員的使用者或連絡人。 繼承自 DirectoryObject。
HTTP 方法:GET、PUT、DELETE |
| directReports | DirectoryObject
(僅支援 User 和 Contact 物件。) | */* | 這名連絡人的直屬員工。 (使用者及連絡人的 manager 屬性設定為這名連絡人。)繼承自 DirectoryObject。
HTTP 方法:GET |
| memberOf | DirectoryObject
(僅支援 Group 物件。) | */* | 這名連絡人隸屬為其成員的群組。 繼承自 DirectoryObject。
HTTP 方法:GET |
注意︰不支援未列出的繼承導覽屬性。 傳送到不支援之導覽屬性的要求會傳回「400 不正確的要求」***。
支援的作業
下列為連絡人支援的作業 (各項作業所使用的 HTTP 方法位於括號內):
- 讀取 (GET)
- 更新 (PATCH):僅適用於未從內部部署目錄同步處理的連絡人 (dirSyncEnabled 是 null 或 false)。
- 刪除 (DELETE)
連絡人導覽屬性支援下列作業,並非每個導覽屬性都支援所有作業。
- 讀取 (GET)
- 更新 (PUT):僅適用於未從內部部署目錄同步處理之連絡人 (dirSyncEnabled 是 null 或 false) 的 manager 屬性。
- 刪除 (DELETE):僅適用於未從內部部署目錄同步處理之連絡人 (dirSyncEnabled 是 null 或 false) 的 manager 屬性。
在連絡人上可以呼叫下列動作和函數:
- checkMemberGroups 可檢查連絡人在群組清單中的成員資格。 此檢查可移轉。
- getMemberGroups 可傳回連絡人隸屬的群組清單。 此檢查可移轉。
- isMemberOf 可檢查連絡人是否為指定群組的成員。 此檢查可移轉。
備註
連絡人是擁有郵件功能的實體,無法使用 Graph API 加以建立。 可更新,但僅限於 dirSyncEnabled 屬性設為 null 或 false 的連絡人才支援更新。 可刪除連絡人。
Contract 實體
只存在於合作夥伴租用戶中。 合作夥伴租用戶是屬於 Microsoft 合作夥伴的 Azure AD 租用戶,這些 Microsoft 合作夥伴可以是 Office 365 同步發佈、Microsoft 雲端解決方案提供者或 Microsoft Advisor 夥伴計劃的一部分。 代表合作夥伴租用戶與客戶租用戶的現有合作關係。 唯讀。 繼承自 DirectoryObject。
重要:在 1.5 版中引進。
屬性
宣告屬性
Name | 類型 | 支援 | 說明 |
---|---|---|---|
contractType | Edm.String | GET | 合約類型。 可能的值為:
|
customerContextId | Edm.Guid | GET ($filter) | 此合作關係所參考之客戶租用戶的唯一識別碼。 對應至客戶租用戶之 TenantDetail 物件的 objectId 屬性。 |
defaultDomainName | Edm.String | GET ($filter) | 客戶租用戶之預設網域名稱的複本。 與客戶建立合作關係時,會建立此複本。 它不會在客戶租用戶的預設網域名稱變更時自動更新。 |
deletionTimestamp | Edm.DateTime | GET | 此屬性對合約而言無效,一律會傳回 null。 繼承自 DirectoryObject。 注意:需要 1.5 版或更新版本。 |
displayName | Edm.String | GET ($filter) | 客戶租用戶之顯示名稱的複本。 與客戶建立合作關係時,會建立此複本。 它不會在客戶租用戶的顯示名稱變更時自動更新。 |
objectType | Edm.String | GET | 識別此物件類型的字串。 這個值一律是 “Contract”。 繼承自 DirectoryObject。 |
objectId | Edm.String | GET | 合作關係的唯一識別碼。 繼承自 DirectoryObject。 注意:索引鍵、不可變、不可為 Null、唯一。 |
導覽屬性
無。
注意︰不支援未列出的繼承導覽屬性。 傳送到不支援之導覽屬性的要求會傳回「400 不正確的要求」****。
支援的作業
下列為合約支援的作業 (各項作業所使用的 HTTP 方法位於括弧內):
- 讀取 (GET)
裝置實體
代表目錄中註冊的裝置。 繼承自 DirectoryObject。
屬性
宣告屬性
Name | 類型 | 支援 | 說明 |
---|---|---|---|
accountEnabled | Edm.Boolean | POST (必要), GET ($filter), PATCH | |
alternativeSecurityIds | Collection(AlternativeSecurityId) | POST (必要), GET ($filter), PATCH | 注意︰不可為 Null,多重值屬性的篩選條件運算式需要 any 運算子;如需詳細資訊,請參閱Supported Queries, Filters, and Paging Options。 |
approximateLastLogonTimeStamp | Edm.DateTime | POST, GET, PATCH | |
deletionTimestamp | Edm.DateTime | GET | 此屬性對裝置而言無效,一律會傳回 null。 繼承自 DirectoryObject。 注意:需要 1.5 版或更新版本。 |
deviceId | Edm.Guid | POST (必要), GET ($filter), PATCH | |
deviceObjectVersion | Edm.Int32 | POST, GET, PATCH | |
deviceOSType | Edm.String | POST (必要), GET, PATCH | 裝置上的作業系統類型。 |
deviceOSVersion | Edm.String | POST (必要), GET, PATCH | 裝置上的作業系統版本 |
devicePhysicalIds | Collection(Edm.String) | POST, GET ($filter), PATCH | 注意:不可為 Null |
dirSyncEnabled | Edm.Boolean | GET ($filter) | 若此物件從內部部署目錄同步處理,則為 true;若此物件原本從內部部署目錄同步處理但已不再同步處理,則為 false;如果此物件從未自內部部署目錄同步處理 (預設值),則為 null。 |
displayName | Edm.String | POST (必要), GET ($filter), PATCH | 裝置的顯示名稱。 |
isCompliant | Edm.Boolean | POST, GET, PATCH | 若裝置符合行動裝置管理 (MDM) 原則,則為 true;否則為 false。 |
IsManaged | Edm.Boolean | POST, GET, PATCH | 若裝置是由行動裝置管理 (MDM) 應用程式 (例如 Intune) 管理,則為 true;否則為 false。 |
lastDirSyncTime | Edm.DateTime | GET ($filter) | 此物件上次與內部部署目錄進行同步處理的時間。 |
objectId | Edm.String | GET | 裝置的唯一識別碼。 繼承自 DirectoryObject。 注意:索引鍵、不可變、不可為 Null、唯一 |
objectType | Edm.String | GET | 識別此物件類型的字串。 對於裝置,這個值一律是 "Device"。 繼承自 DirectoryObject |
導覽屬性
Name | 收件者 | 多重性 (來源/目的地) |
說明 |
---|---|---|---|
registeredOwners | [使用者] | */* | 身為裝置之註冊擁有者的使用者。 |
registeredUsers | [使用者] | */* | 身為裝置之註冊使用者的使用者。 |
注意︰不支援未列出的繼承導覽屬性。 傳送到不支援之導覽屬性的要求會傳回「400 不正確的要求」****。
支援的作業
下列為裝置支援的作業 (HTTP 方法位於括弧內):
- 建立 (CREATE)
- 讀取 (READ)
- 更新 (PATCH)
- 刪除 (DELETE)
裝置導覽屬性支援下列作業。 並非每個導覽屬性都支援所有作業。
- 讀取 (READ)
- 更新 (PUT)
- 刪除 (DELETE)
裝置不支援函數或動作。
DirectoryLinkChange 實體
在差異查詢的結果集中傳回 DirectoryLinkChange 物件,指出以連結表示的連絡人、使用者或群組的屬性在上次差異查詢後已變更。 DirectoryLinkChange 物件將代表使用者或連絡人 manager 屬性的變更,或群組 members 屬性的變更。 如需差異查詢的詳細資訊,請參閱Differential Query。 繼承自 DirectoryObject。
屬性
宣告屬性
Name | 類型 | 支援 | 說明 |
---|---|---|---|
associationType | Edm.String | GET | 識別套用變更的關聯類型的字串。 值可以是 "Member" 或 "Manager"。 |
deletionTimestamp | Edm.DateTime | GET | 此屬性對目錄連結變更物件而言無效,一律會傳回 null。 繼承自 DirectoryObject。 注意:需要 1.5 版或更新版本。 |
objectId | Edm.String | GET | 目錄連結變更物件的唯一識別碼。 對於 DirectoryLinkChange 物件,這個值一律是 00000000-0000-0000-0000-000000000000。 繼承自 DirectoryObject。 注意:索引鍵、不可變、不可為 Null、唯一 |
objectType | Edm.String | GET | 識別此物件類型的字串。 對於 DirectoryLinkChange 物件,這個值一律是 "DirectoryLinkChange"。 DirectoryObject |
sourceObjectId | Edm.String | GET | 來源物件的物件識別碼,例如 "7373b0af-d462-406e-ad26-f2bc96d823d8"。 |
sourceObjectType | Edm.String | GET | 識別來源物件類型的字串;這可以是下列其中一項:"Group"、"User" 或 "Contact"。 |
sourceObjectUri | Edm.String | GET | 來源物件的 URI,例如 "https://graph.windows.net/contoso.com/groups/7373b0af-d462-406e-ad26-f2bc96d823d8" 。 |
targetObjectId | Edm.String | GET | 目標物件的物件識別碼,例如 "dca803ab-bf26-4753-bf20-e1c56a9c34e2"。 |
targetObjectType | Edm.String | GET | 識別來源物件類型的字串;這可以是下列其中一項:"Group"、"User" 或 "Contact"。 |
targetObjectUri | Edm.String | GET | 目標物件的 URI,例如 "https://graph.windows.net/contoso.com/users/dca803ab-bf26-4753-bf20-e1c56a9c34e2" 。 |
導覽屬性
無。
注意︰不支援未列出的繼承導覽屬性。 傳送到不支援之導覽屬性的要求會傳回「400 不正確的要求」****。
DirectoryObject 實體
代表 Azure Active Directory 物件。 DirectoryObject 類型是其他大多數目錄實體類型的基底類型。
屬性
宣告屬性
| Name | 類型 | 支援 | 說明 |
|:----|:----|:----------|:----------|
| deletionTimestamp | Edm.DateTime | GET | 刪除目錄物件的時間。 僅適用於可還原的目錄物件。 目前僅支援已刪除的 Application 物件,對於其他所有實體,此屬性會傳回 null。
注意:需要 1.5 版或更新版本。 |
| objectId | Edm.String | GET | Guid 為物件的唯一識別碼,例如 12345678-9abc-def0-1234-56789abcde。
注意:索引鍵、不可變、不可為 Null、唯一。 |
| objectType | Edm.String | GET | 識別此物件類型的字串。 例如,對於群組,這個值一律是 "Group"。 |
導覽屬性
Name | 收件者 | 多重性 (來源/目的地) |
說明 |
---|---|---|---|
createdObjects | DirectoryObject | */* | 目前物件所建立的目錄物件。 唯讀。 需要 2013-11-08 版本或更新版本。 |
createdOnBehalfOf | DirectoryObject | */0..1 | 建立此物件所要代表的目錄物件。 唯讀。 需要 2013-11-08 版本或更新版本。 |
manager | DirectoryObject | */0..1 | 這個物件的管理員。 在使用者與連絡人中有效。 傳回使用者或連絡人。 |
directReports | DirectoryObject | */* | 負責向此物件報告的使用者及連絡人。 在使用者與連絡人中有效。 傳回使用者和連絡人。 唯讀。 |
members | DirectoryObject | */* | 這些物件為此物件的成員。 在群組和角色中有效。 在群組中,傳回連絡人、使用者及群組。 在角色中,傳回使用者和服務主體。 |
memberOf | DirectoryObject | */* | 此物件為成員之一的眾多物件。 在連絡人、群組、服務主體和使用者中有效。 在連絡人中,傳回群組。 在群組中,傳回群組。 在使用者中,傳回群組及角色。 在服務主體中,傳回角色。 唯讀。 不轉移屬性。 例如,如果使用者 A 是群組 B 的成員,而群組 B 是群組 C 的成員,則使用者 A 中的 memberOf 屬性不會傳回群組 C。 |
ownedObjects | DirectoryObject | */* | 目前物件所擁有的目錄物件。 唯讀。 需要 2013-11-08 版本或更新版本。 |
owners | DirectoryObject | */* | 做為目前物件之擁有者的目錄物件。 擁有者是一組允許修改此物件的非系統管理員使用者。 需要 2013-11-08 版本或更新版本。 |
注意:在繼承自 DirectoryObject 的實體類型上,並非所有導覽屬性都一定有效。 如果傳送對特定實體無效之屬性的要求,會傳回「400 不正確的要求」****回應。 如需哪些導覽屬性在特定實體中有效的相關資訊,請參閱該實體類型的文件集。
支援的作業
目錄物件中支援的完整作業集如下 (各項作業所使用的 HTTP 方法位於括號內):建立 (POST)、讀取 (GET)、更新 (PATCH) 和刪除 (DELETE)。 然而,並非每個實體類型都支援所有作業。 目錄物件的宣告屬性是唯讀的,不能在建立或更新作業中指定。
每個導覽屬性可能支援的一組作業如下:
- createdObjects:讀取 (GET)。
- createdOnBehalfOf:讀取 (GET)。
- manager:讀取 (GET)、更新 (PUT) 和刪除 (DELETE)。
- directReports:讀取 (GET)。
- members:讀取 (GET)、更新 (POST) 和刪除 (DELETE)。
- memberOf:讀取 (GET)。
- ownedObjects:讀取 (GET)。
- owners:讀取 (GET)、更新 (POST) 和刪除 (DELETE)。
並非每個實體類型都必定支援所有導覽屬性,每個實體類型也不一定都支援導覽屬性的潛在作業集。
特定目錄物件是否支援特定動作或函數,取決於目錄物件的類型 (objectType 屬性)。 如需哪些物件類型支援哪些函數或動作的相關資訊,請參閱特定物件 (例如使用者、群組等) 或特定函數的文件。
如需實體支援之作業的資訊,請參閱特定實體類型的文件。
DirectoryRole 實體
代表 Azure AD 目錄角色。 Azure AD 目錄角色也稱為「系統管理員角色」** (administrator role)。 如需目錄 (系統管理員) 角色的詳細資訊,請參閱在 Azure Active Directory (Azure AD) 中指派系統管理員角色。
Graph API 可讓您將使用者和服務主體指派給目錄角色,以授與目標角色的權限給他們。 您可以讀取目錄角色物件並更新目錄角色的 members 導覽屬性,但無法刪除目錄角色或更新其宣告的屬性。 繼承自 DirectoryObject。
若要讀取目錄角色或更新其成員,必須先在租用戶中啟用目錄角色。 在 1.5 之前的版本中,預設已啟用所有目錄角色。 自 1.5 版起,預設只會啟用公司系統管理員目錄角色。 若要啟用其他可用的目錄角色,您可以傳送 POST 要求,其中包含目錄角色所依據之 DirectoryRoleTemplate 的 objectId。 如需詳細資訊,請參閱支援的作業和備註。
重要:自 1.5 版起,Role 實體類型已重新命名為 DirectoryRole。
屬性
宣告屬性
Name | 類型 | 支援 | 說明 |
---|---|---|---|
deletionTimestamp | Edm.DateTime | GET | 此屬性對目錄角色而言無效,一律會傳回 null。 繼承自 DirectoryObject。 注意:需要 1.5 版或更新版本。 |
描述 | Edm.String | GET | 目錄角色的描述。 |
displayName | Edm.String | GET | 目錄角色的顯示名稱。 |
isSystem | Edm.Boolean | GET | 若角色為系統角色,則為 true;否則為 false。 |
objectId | Edm.String | GET | 目錄角色的唯一識別碼。 繼承自 DirectoryObject。 注意:索引鍵、不可變、不可為 Null、唯一。 |
objectType | Edm.String | GET | 識別此物件類型的字串。 對於目錄角色,這個值一律是 "DirectoryRole"。 繼承自 DirectoryObject。 注意:在 1.5 之前的版本中,此值會是 "Role"。 |
roleDisabled | Edm.Boolean | GET | 若已停用目錄角色,則為 true;否則為 false。 |
roleTemplateId | 字串 | POST (必要), GET | 此角色所根據之 DirectoryRoleTemplate 的 objectId。 注意︰在 1.5 版之前的版本中,此屬性是唯讀的。 在 1.5 版及更新版本中,此屬性必須在使用 POST 作業啟用租用戶中的目錄角色時指定。 啟用目錄角色之後,此屬性會變成唯讀。 |
導覽屬性
名稱 | 目標 | 多重性 (來源/目的地) |
描述 |
---|---|---|---|
members | DirectoryObject (支援 User 和 ServicePrincipal。) |
/ | 屬於此目錄角色之成員的使用者及服務主體。 繼承自 DirectoryObject。 HTTP 方法:GET、POST、DELETE |
注意︰不支援未列出的繼承導覽屬性。 傳送到不支援之導覽屬性的要求會傳回「400 不正確的要求」****。
支援的作業
下列為目錄角色支援的作業 (各項作業所使用的 HTTP 方法位於括弧內):
- 建立 (POST):1.5 版及更新版本支援此做法。 使用要求中 roleTemplateId 屬性所指定的 DirectoryRoleTemplate,來啟用租用戶中的目錄角色。 啟用目錄角色之後,您可以對角色加入及刪除使用者和服務主體。
- 讀取 (GET)
下列為目錄角色導覽屬性支援的作業:
- 讀取 (GET)
- 更新 (POST)
- 刪除 (DELETE)
在目錄角色上無法呼叫任何函數或動作;不過,您可以在 User 或 ServicePrincipal 上呼叫 getMemberObjects 來判斷其目錄角色成員資格。 請注意,若是使用者,此函數也會傳回其直接和可轉移的群組成員資格。
備註
- 在 1.5 版及更新版本中,預設只會啟用 (並顯示) 租用戶中的公司系統管理員角色。 使用建立 (POST) 作業可啟用其他目錄角色。 此作業指定要求中的 roleTemplateId 屬性。 此屬性包含 DirectoryRoleTemplate 執行個體的 objectId,該執行個體會對應至您要啟用的角色。 啟用目錄角色之後,您可以使用 Graph API 對其加入及刪除使用者和服務主體。 在 1.5 之前的版本中,預設會啟用所有目錄角色 (以 Role 實體表示),且不支援建立 (POST) 作業。
- 無法使用 Graph API 刪除目錄角色。 只有 members 導覽屬性上才支援更新。 此屬性上支援加入和移除。
- 查詢篩選器運算式不支援目錄角色。
DirectoryRoleTemplate 實體
代表目錄角色範本。 目錄角色範本指定目錄角色 (DirectoryRole) 的屬性值。 每個可能在租用戶中啟用的目錄角色都有相關聯的目錄角色範本物件。 繼承自 DirectoryObject。
若要讀取目錄角色或更新其成員,必須先在租用戶中啟用目錄角色。 在 1.5 之前的版本中,預設已啟用所有目錄角色。 自 1.5 版起,預設只會啟用公司系統管理員目錄角色。 若要啟用其他可用的目錄角色,您可以將 POST 要求傳送到 /directoryRoles 端點,其中包含目錄角色所依據之目錄角色範本的 objectId (在要求的 roleTemplateId 參數中指定)。 如需詳細資訊,請參閱 DirectoryRole。
注意︰目錄角色範本會公開給 Users 目錄角色。 Users 目錄角色是隱含的,目錄用戶端看不到這個角色。 基礎結構會將租用戶中的每個 User 指派給此角色。 此角色已經啟用。 請勿使用此範本。
重要:在 1.5 版中引進。
屬性
宣告屬性
Name | 類型 | 支援 | 說明 |
---|---|---|---|
描述 | Edm.String | GET | 為目錄角色設定的描述。 |
deletionTimestamp | Edm.DateTime | GET | 此屬性對目錄角色範本而言無效,一律會傳回 null。 繼承自 DirectoryObject。 注意:需要 1.5 版或更新版本。 |
displayName | Edm.String | GET | 為目錄角色設定的顯示名稱。 |
objectId | Edm.String | GET | 範本的唯一識別碼。 繼承自 DirectoryObject。 在 1.5 版及更新版本中,您可以指定目錄角色範本的 objectId,讓 POST 要求中的 roleTemplateId 屬性啟用租用戶中的 DirectoryRole。 注意:索引鍵、不可變、不可為 Null、唯一。 |
objectType | Edm.String | GET | 識別此物件類型的字串。 對於角色範本,這個值一律是 "RoleTemplate"。 繼承自 DirectoryObject。 |
導覽屬性
無。
注意︰不支援未列出的繼承導覽屬性。 傳送到不支援之導覽屬性的要求會傳回「400 不正確的要求」****。
支援的作業
下列為目錄角色範本支援的作業 (HTTP 方法位於括 內):
- 讀取 (GET)
Domain 實體 (預覽)
代表與租用戶相關聯的網域。
重要︰只在搶鮮版 (Beta) 中可用。
屬性
宣告屬性
Name | 類型 | 支援 | 說明 |
---|---|---|---|
authenticationType | Edm.String | GET | 指出網域的驗證類型設定。 值可以是 "Managed" 或 "Federated"。 |
availabilityStatus | Edm.String | GET | 除非使用 verify 動作,否則此屬性一律為 null。 使用 verify 動作時,會在回應中傳回 Domain 實體。 回應中 Domain 實體的 availabilityStatus 屬性是 "AvailableImmediately" 或 "EmailVerifiedDomainTakeoverScheduled"。 |
isAdminManaged | Edm.Boolean | GET | 若網域的 DNS 記錄管理已委派給 Office 365,則為 false; 否則為 true。 注意:不可為 Null |
isDefault | Edm.Boolean | GET, PATCH | 指出這是否為建立使用者所使用的預設網域。 一家公司只有一個預設網域。 注意:不可為 Null |
isInitial | Edm.Boolean | GET | 指出這是否為 Microsoft Online Services 所建立的初始網域 (companyname.onmicrosoft.com)。 一家公司只有一個初始網域。 注意:不可為 Null |
isRoot | Edm.Boolean | GET | 對於子網域,這代表根網域。 只需要驗證根網域,而且會自動驗證所有子網域。 注意:不可為 Null |
isVerified | Edm.Boolean | GET | 指出這個網域是否已完成驗證網域擁有權。 注意:不可為 Null |
名稱 | Edm.String | POST (必要), GET ($filter) | 網域的完整名稱。 注意:索引鍵、不可變、不可為 Null、唯一 |
supportedServices | Collection(Edm.String) | GET, PATCH | 指派給網域的功能。 可包含下列一或多個值,或不包含任何值:
上述大部分的值都是唯讀的。 您可以使用 Graph API 加入/移除的值包括︰
注意:不可為 Null |
導覽屬性
Name | 收件者 | 多重性 (來源/目的地) |
說明 |
---|---|---|---|
serviceConfigurationRecords | DomainDnsRecord | */* | 客戶必須加入網域之 DNS 區域檔案中的 DNS 記錄,在這之後,才能讓 Microsoft Online Services 使用網域。 |
verificationDnsRecords | DomainDnsRecord | */* | 客戶必須加入網域之 DNS 區域檔案中的 DNS 記錄,在這之後,客戶才能向 Azure AD 完成驗證網域擁有權。 |
DomainDnsRecord 實體 (預覽)
針對租用戶中的每個網域,您可能必須將 DNS 記錄加入網域的 DNS 區域檔案中,在這之後,才能讓 Microsoft Online Services 使用網域。 DomainDnsRecord 實體可用來呈現這類 DNS 記錄。 DomainDnsCnameRecord、DomainDnsMxRecord、DomainDnsSrvRecord 和 DomainDnsSrvRecord 實體的基底實體。
重要︰只在搶鮮版 (Beta) 中可用。
屬性
宣告屬性
Name | 類型 | 支援 | 說明 |
---|---|---|---|
dnsRecordId | Edm.Guid | GET | 指派給此實體的唯一識別碼。 注意:不可為 Null |
isOptional | Edm.Boolean | GET | 指出是否必須由客戶在 DNS 主機上設定此記錄,Microsoft Online Services 才能正常使用網域。 注意:不可為 Null |
label | Edm.String | GET | 指出在 DNS 主機上設定 DNS 記錄的名稱時所要使用的值。 |
recordType | Edm.String | GET | 指出此實體所代表的 DNS 記錄類型。 這個值可以是下列其中一個值:
注意:索引鍵 |
supportedService | Edm.String | GET | 指出哪些 Microsoft Online Services 或功能會相依於此 DNS 記錄。 可以是下列其中一個值:
|
ttl | Edm.Int32 | GET | 指出在 DNS 主機上設定 DNS 記錄的 Time-To-Live (ttl) 屬性時所要使用的值。 注意:不可為 Null |
DomainDnsCnameRecord 實體 (預覽)
代表需要加入租用戶中特定網域之 DNS 區域檔案中的 CNAME 記錄。 繼承自 DomainDnsRecord 實體。
重要︰只在搶鮮版 (Beta) 中可用。
屬性
宣告屬性
Name | 類型 | 支援 | 說明 |
---|---|---|---|
canonicalName | Edm.String | GET | 指出在 DNS 主機上設定 CNAME 記錄的正式名稱時所要使用的值。 |
dnsRecordId | Edm.Guid | GET | 指派給此實體的唯一識別碼。 注意:不可為 Null |
isOptional | Edm.Boolean | GET | 指出是否必須由客戶在 DNS 主機上設定此 CNAME 記錄,Microsoft Online Services 才能正常使用網域。 注意:不可為 Null |
label | Edm.String | GET | 指出在 DNS 主機上設定 CNAME 記錄的名稱時所要使用的值。 |
recordType | Edm.String | GET | 指出此實體所代表的 DNS 記錄類型。 這個值一律是 "CName"。 注意:索引鍵 |
supportedService | Edm.String | GET | 指出哪些 Microsoft Online Services 或功能會相依於此 CNAME 記錄。 可以是下列其中一個值:
|
ttl | Edm.Int32 | GET | 指出在 DNS 主機上設定 CNAME 記錄的 Time-To-Live (ttl) 屬性時所要使用的值。 注意:不可為 Null |
DomainDnsMxRecord 實體 (預覽)
代表需要加入租用戶中特定網域之 DNS 區域檔案中的 MX 記錄。 繼承自 DomainDnsRecord 實體。
重要︰只在搶鮮版 (Beta) 中可用。
屬性
宣告屬性
Name | 類型 | 支援 | 說明 |
---|---|---|---|
dnsRecordId | Edm.Guid | GET | 指派給此實體的唯一識別碼。 注意:不可為 Null |
isOptional | Edm.Boolean | GET | 指出是否必須由客戶在 DNS 主機上設定此 MX 記錄,Microsoft Online Services 才能正常使用網域。 注意:不可為 Null |
label | Edm.String | GET | 在 DNS 主機上設定 MX 記錄的 Alias/Host/Name 屬性時所要使用的值。 |
mailExchange | Edm.String | GET | 在 DNS 主機上設定 MX 記錄的 Answer/Destination/Value 時所要使用的值。 |
recordType | Edm.String | GET | 指出此實體所代表的 DNS 記錄類型。 這個值一律是 "Mx"。 注意:索引鍵 |
preference | Edm.Int32 | GET | 在 DNS 主機上設定 MX 記錄的 Preference/Priority 屬性時所要使用的值。 |
supportedService | Edm.String | GET | 指出哪些 Microsoft Online Services 或功能會相依於此 CNAME 記錄。 可以是下列其中一個值:
|
ttl | Edm.Int32 | GET | 在 DNS 主機上設定 MX 記錄的 Time-To-Live (ttl) 屬性時所要使用的值。 注意:不可為 Null |
DomainDnsSrvRecord Entity 實體 (預覽)
代表需要加入租用戶中特定網域之 DNS 區域檔案中的 SRV 記錄。 繼承自 DomainDnsRecord 實體。
重要︰只在搶鮮版 (Beta) 中可用。
屬性
宣告屬性
Name | 類型 | 支援 | 說明 |
---|---|---|---|
dnsRecordId | Edm.Guid | GET | 指派給此實體的唯一識別碼。 注意:不可為 Null |
isOptional | Edm.Boolean | GET | 指出是否必須由客戶在 DNS 主機上設定此 SRV 記錄,Microsoft Online Services 才能正常使用網域。 注意:不可為 Null |
label | Edm.String | GET | 在 DNS 主機上設定 SRV 記錄的 Name 屬性時所要使用的值。 |
nameTarget | Edm.String | GET | 在 DNS 主機上設定 SRV 記錄的 Target 屬性時所要使用的值。 |
port | Edm.Int32 | GET | 在 DNS 主機上設定 SRV 記錄的 Port 屬性時所要使用的值。 |
優先順序 | Edm.Int32 | GET | 在 DNS 主機上設定 SRV 記錄的 Priority 屬性時所要使用的值。 |
通訊協定 | Edm.String | GET | 在 DNS 主機上設定 SRV 記錄的 Protocol 屬性時所要使用的值。 |
recordType | Edm.String | GET | 指出此實體所代表的 DNS 記錄類型。 這個值一律是 "Srv"。 注意:索引鍵 |
Service | Edm.String | GET | 在 DNS 主機上設定 SRV 記錄的 Service 屬性時所要使用的值。 |
supportedService | Edm.String | GET | 指出哪些 Microsoft Online Services 或功能會相依於此 SRV 記錄。 可以是下列其中一個值:
|
ttl | Edm.Int32 | GET | 在 DNS 主機上設定 SRV 記錄的 Time-To-Live 屬性時所要使用的值。 注意:不可為 Null |
weight | Edm.Int32 | GET | 在 DNS 主機上設定 SRV 記錄的 Weight 屬性時所要使用的值。 |
DomainDnsTxtRecord Entity 實體 (預覽)
代表需要加入租用戶中特定網域之 DNS 區域檔案中的 TXT 記錄。 繼承自 DomainDnsRecord 實體。
重要︰只在搶鮮版 (Beta) 中可用。
屬性
宣告屬性
Name | 類型 | 支援 | 說明 |
---|---|---|---|
dnsRecordId | Edm.Guid | GET | 指派給此實體的唯一識別碼。 注意:不可為 Null |
isOptional | Edm.Boolean | GET | 指出是否必須由客戶在 DNS 主機上設定此 MX 記錄,Microsoft Online Services 才能正常使用網域。 注意:不可為 Null |
label | Edm.String | GET | 在 DNS 主機上設定 MX 記錄的 Alias/Host/Name 屬性時所要使用的值。 |
recordType | Edm.String | GET | 指出此實體所代表的 DNS 記錄類型。 這個值一律是 "Mx"。 注意:索引鍵 |
supportedService | Edm.String | GET | 指出哪些 Microsoft Online Services 或功能會相依於此 CNAME 記錄。 可以是下列其中一個值:
|
文字 | Edm.String | GET | |
ttl | Edm.Int32 | GET | 在 DNS 主機上設定 TXT 記錄的 Time-To-Live 屬性時所要使用的值 (以秒為單位)。 注意:不可為 Null |
DomainDnsUnavailableRecord 實體 (預覽)
繼承自 DomainDnsRecord 實體。 當您查詢 Domain 實體的導覽屬性 serviceConfigurationRecords 時,您可能會收到 DomainDnsCnameRecord、DomainDnsMxRecord、DomainDnsSrvRecord 及/或 DomainDnsTxtRecord 實體的其中一或多個。 這些實體指出您必須加入網域之區域檔案中的 DNS 記錄,在這之後,才能讓 Microsoft Online Services 使用網域。 無法產生這類實體時,會改為傳回 DomainDnsUnavailableRecord 實體。
重要︰只在搶鮮版 (Beta) 中可用。
屬性
宣告屬性
Name | 類型 | 支援 | 說明 |
---|---|---|---|
描述 | Edm.String | GET | 提供傳回 DomainDnsUnavailableRecord 實體的原因。 |
ExtensionProperty 實體
可讓應用程式定義並使用一組額外的屬性,且這些屬性可加入至目錄物件 (使用者、群組、租用戶詳細資料、裝置、應用程式和服務主體),應用程式並不需要外部資料存放區。 如需擴充功能屬性的詳細資訊,請參閱Directory Schema Extensions。 繼承自 DirectoryObject。
重要:ExtensionProperty 在 1.5 版中引進。
屬性
宣告屬性
Name | 類型 | 支援 | 說明 |
---|---|---|---|
appDisplayName | Edm.String | GET | |
dataType | Edm.String | POST, GET, PATCH | 指定要加入的目錄延伸模組屬性型別。 支援的類型包括:Integer、LargeInteger、DateTime (必須以 ISO 8601 指定 - DateTime 以 UTC 儲存)、Binary、Boolean 和 String。 |
deletionTimestamp | Edm.DateTime | GET | 此屬性對擴充功能屬性而言無效,一律會傳回 null。 繼承自 DirectoryObject。 |
objectId | Edm.String | GET | 擴充功能屬性的唯一識別碼。 繼承自 DirectoryObject。 注意:索引鍵、不可變、不可為 Null、唯一。 |
objectType | Edm.String | GET | 識別此物件類型的字串。 對於擴充功能屬性,這個值一律是 "ExtensionProperty"。 繼承自 DirectoryObject。 |
名稱 | Edm.String | POST, GET, PATCH | 指定目錄延伸模組屬性的顯示名稱。 注意:不可為 Null。 |
isSyncedFromOnPremises | Edm.Boolean | GET | 指出是否從內部部署目錄同步處理延伸模組屬性。 注意:不可為 Null。 |
targetObjects | Collection(Edm.String) | POST, GET, PATCH | 要加入目錄延伸模組屬性的目錄物件。 可延伸的受支援目錄實體包括:"User"、"Group"、"TenantDetail"、"Device"、"Application" 和 "ServicePrincipal" 注意:不可為 Null。 |
導覽屬性
無。
注意︰不支援未列出的繼承導覽屬性。 傳送到不支援之導覽屬性的要求會傳回「400 不正確的要求」****。
Group 實體
代表 Azure Active Directory 群組。 繼承自 DirectoryObject。
屬性
宣告屬性
Name | 類型 | 支援 | 說明 |
---|---|---|---|
deletionTimestamp | Edm.DateTime | GET | 此屬性對群組而言無效,一律會傳回 null。 繼承自 DirectoryObject。 注意:需要 1.5 版或更新版本。 |
描述 | Edm.String | POST, GET, PATCH | 群組的選擇性描述。 |
dirSyncEnabled | Edm.Boolean | GET ($filter) | 若此物件從內部部署目錄同步處理,則為 true;若此物件原本從內部部署目錄同步處理但已不再同步處理,則為 false;如果此物件從未自內部部署目錄同步處理 (預設值),則為 null。 |
displayName | Edm.String | POST (必要), GET ($filter), PATCH | 群組的顯示名稱。 建立群組時需要此屬性,且在更新期間無法將其清除。 |
lastDirSyncTime | Edm.DateTime | GET ($filter) | 指出此物件上次與內部部署目錄進行同步處理的時間。 |
Edm.String | GET ($filter) | 群組的 SMTP 位址,例如 "serviceadmins@contoso.onmicrosoft.com"。 | |
mailEnabled | Edm.Boolean | POST (必要), GET, PATCH | 指定群組是否擁有郵件功能。 如果 securityEnabled 屬性也為 true,該群組為擁有郵件功能的安全性群組;若否,則該群組為 Microsoft Exchange 通訊群組。 使用 Azure AD Graph 僅可建立 (單純的) 安全性群組。 因此,當建立群組且其不能使用 Azure AD Graph 更新時,必須將屬性設定為 false。 |
mailNickname | Edm.String | POST (必要), GET ($filter), PATCH | 群組的郵件別名。 建立群組時必須指定此屬性。 |
objectId | Edm.String | GET | 群組的唯一識別碼。 繼承自 DirectoryObject。 注意:索引鍵、不可變、不可為 Null、唯一。 |
objectType | Edm.String | GET | 識別此物件類型的字串。 對於群組,這個值一律是 "Group"。 繼承自 DirectoryObject。 |
onPremisesSecurityIdentifier | 字串 | GET | 包含已從內部部署同步至雲端之群組的內部部署安全性識別碼 (SID)。 注意:需要 1.5 版或更新版本。 |
provisioningErrors | Collection(ProvisioningError) | GET | 導致無法成功佈建此群組之錯誤詳細資料的集合。 注意:不可為 Null。 |
proxyAddresses | Collection(Edm.String) | GET ($filter) | 注意︰不可為 Null,多重值屬性的篩選條件運算式需要 any 運算子;如需詳細資訊,請參閱Supported Queries, Filters, and Paging Options。 |
securityEnabled | Edm.Boolean | POST (必要), GET ($filter), PATCH | 指定群組是否為安全性群組。 如果 mailEnabled 屬性也為 true,該群組為擁有郵件功能的安全性群組,若否,則此為安全性群組。 使用 Azure AD Graph 僅可建立 (單純的) 安全性群組。 因此,在建立群組時必須將此屬性設定為 true。 |
導覽屬性
Name | 收件者 | 目標多重性 | 說明 |
---|---|---|---|
members | DirectoryObject (僅支援 Contact、Group、ServicePrincipal 和 User 物件) |
*/* | 屬於此群組之成員的使用者、連絡人、群組及服務主體。 繼承自 DirectoryObject。 HTTP 方法︰GET (支援所有群組)、POST (支援安全性群組和擁有郵件功能的安全性群組)、DELETE (僅支援安全性群組) |
memberOf | DirectoryObject (僅支援 Group 物件) |
*/* | 此群組隸屬為其成員的群組。 繼承自 DirectoryObject。 HTTP 方法︰GET (支援所有群組) |
owners | DirectoryObject | */* | 群組的擁有者。 擁有者是一組允許修改此物件的非系統管理員使用者。 需要 2013-11-08 版本或更新版本。 繼承自 DirectoryObject。 HTTP 方法︰GET (支援所有群組)、POST (支援安全性群組和擁有郵件功能的安全性群組)、DELETE (僅支援安全性群組) |
appRoleAssignments | DirectoryObject | */* | 包含群組所指派到的應用程式集。 注意:需要 1.5 版或更新版本。 |
extensionProperties | DirectoryObject | */* | 包含與應用程式相關聯的延伸模組屬性。 注意:需要 1.5 版或更新版本。 |
注意︰不支援未列出的繼承導覽屬性。 傳送到不支援之導覽屬性的要求會傳回「400 不正確的要求」****。
支援的作業
下列為使用者支援的作業 (各項作業所使用的 HTTP 方法位於括號內):
- 建立 (POST)︰僅支援安全性群組。
- 讀取 (GET):支援所有群組。
- 更新 (PATCH)︰僅支援安全性群組和擁有郵件功能的安全性群組。 不是所有屬性皆可更新。
- 刪除 (DELETE):僅支援安全性群組。
下列為群組導覽屬性支援的作業:
- 讀取 (GET):支援所有群組。
- 更新 (POST):僅支援安全性群組和擁有郵件功能的安全性群組。 (僅限成員和擁有者。)
- 刪除 (DELETE):僅支援安全性群組。 (僅限成員和擁有者。)
在群組上可以呼叫下列動作和函數:
- checkMemberGroups 可檢查群組在群組清單中的成員資格。 此檢查可移轉。
- getAvailableExtensionProperties 可傳回群組已註冊的擴充功能屬性清單。 需要 1.5 版或更新版本。
- getMemberGroups 可傳回群組隸屬的群組清單。 此檢查可移轉。
- isMemberOf 可檢查群組是否為指定群組的成員。 此檢查可移轉。
備註
- 共有三種群組:郵件通訊群組 (mailEnabled 屬性為 true 和 securityEnabled 屬性為 false)、擁有郵件功能的安全性群組 (mailEnabled 屬性為 true 和 securityEnabled 屬性為 true),以及 (單純的) 安全性群組 (mailEnabled 屬性為 false 和 securityEnabled 屬性為 true)。
- 您只能使用 Graph API 建立安全性群組 (無法建立擁有郵件功能的安全性群組或郵件通訊群組)。 因此,在建立群組時,mailEnabled 屬性必須設定為 false****securityEnabled 屬性必須設定為 true。
- 當使用 Graph API 建立安全性群組時,必須指定所有標示為必要的屬性。 這些屬性如下:displayName、mailNickname、mailEnabled (false) 及 securityEnabled (true)。
- 您無法使用 Graph API 將群組由安全性群組更新為擁有郵件功能的安全性群組或郵件通訊群組。
LicenseDetail 實體
包含指派給使用者的授權資訊。
User 實體的 licenseDetails 屬性屬於 LicenseDetail 類型。
重要:在 1.6 版中引進。
屬性
宣告屬性
屬性 | 類型 | 支援 | 說明 |
---|---|---|---|
objectId | Edm.String | GET | 授權詳細資料物件的唯一識別碼。 注意:索引鍵、不可為 Null。 |
servicePlans | Collection(ServicePlanInfo) | GET | 指派授權之服務方案的相關資訊。 注意:不可為 Null。 |
skuId | Edm.Guid | GET | 服務 SKU 的唯一識別碼 (GUID)。 等同於相關 SubscribedSku 物件的 skuId 屬性。 |
skuPartNumber | Edm.String | GET | 唯一的 SKU 顯示名稱。 等同於相關 SubscribedSku 物件的 skuPartNumber,例如:"AAD_Premium"。 |
導覽屬性
無。
注意︰不支援未列出的繼承導覽屬性。 傳送到不支援之導覽屬性的要求會傳回「400 不正確的要求」****。
支援的作業
下列為授權詳細資料支援的作業 (各項作業所使用的 HTTP 方法位於括弧內):
- 建立 (POST)
- 讀取 (GET)
- 更新 (PATCH)
- 刪除 (DELETE)
在授權詳細資料上無法呼叫任何函數或動作。
OAuth2PermissionGrant 實體
代表已授予應用程式 (以服務主體表示) 的 OAuth 2.0 委派權限範圍,作為使用者或管理員同意程序一部分。
重要:自 1.5 版起,Permission 實體類型已重新命名為 OAuth2PermissionGrant。 在 1.5 之前的版本中,在同意過程中所建立的權限會加入使用者或服務主體的 permissions 屬性中。
屬性
宣告屬性
屬性 | 類型 | 支援 | 說明 |
---|---|---|---|
clientId | Edm.String | POST、GET | 指定服務主體的 objectId 同意在存取資源 (以 resourceId 表示) 時模擬使用者。 |
consentType | Edm.String | POST、GET | 指定代表組織的系統管理員是否提供同意,或個人是否提供同意。 可能的值為 "AllPrincipals" 或 "Principal"。 |
expiryTime | Edm.DateTime | POST, GET, PATCH | 已保留。 傳回 null。 請勿使用。 |
objectId | Edm.String | GET | 權限範圍的唯一識別碼。 注意:索引鍵、不可為 Null。 |
principalId | Edm.String | POST、GET | 如果 consentType 是 "AllPrincipals",此值則為 Null,且會對組織中的所有使用者套用此同意。 如果 consentType 是 "Principal",則此屬性會指定同意的使用者 objectId,並僅對該使用者套用。 |
resourceId | Edm.String | POST、GET | 指定已授與存取權的資源服務主體 objectId。 |
範圍 | Edm.String | POST, GET, PATCH | 指定資源應用程式預期會在 OAuth 2.0 存取權杖中看到的範圍宣告值。 |
startTime | Edm.DateTime | POST、GET | 已保留。 傳回 null。 請勿使用。 |
導覽屬性
無。
注意︰不支援未列出的繼承導覽屬性。 傳送到不支援之導覽屬性的要求會傳回「400 不正確的要求」****。
支援的作業
下列是權限範圍所支援的作業 (各項作業所使用的 HTTP 方法會顯示在括號中):
- 建立 (POST)
- 讀取 (GET)
- 更新 (PATCH):僅限 scope 屬性。
- 刪除 (DELETE)
可能無法在權限範圍上呼叫任何函數或動作。
備註
- 在 1.5 版及更新版本中,User 實體和 ServicePrincipal 實體的 oauth2PermissionGrants 導覽屬性會傳回與使用者或服務主體相關聯的 OAuth2PermissionGrant 物件。
- 在 1.5 之前的版本中,User 實體和 ServicePrincipal 實體的 permissions 導覽屬性會傳回與使用者或服務主體相關聯的 Permission 物件。
ServiceEndpoint 實體
此服務端點實體包含服務探索資訊。 繼承自 DirectoryObject。
Application 和 ServicePrincipal 實體的 ServiceEndpoints 屬性屬於 ServiceEndpoint 類型。 其他服務可以使用儲存在 ServiceEndpoint 實體中的資訊,來尋找此服務及其可定址的端點。
重要:在 1.6 版中引進。
屬性
宣告屬性
屬性 | 類型 | 支援 | 說明 |
---|---|---|---|
功能 | Edm.String | POST (必要), GET | 服務功能的文字識別碼。 範例包括 "Documents" 和 "Mail"。 |
deletionTimestamp | Edm.DateTime | GET | 此屬性對服務端點而言無效,一律會傳回 null。 繼承自 DirectoryObject。 |
objectId | Edm.String | GET | 服務端點的唯一識別碼。 繼承自 DirectoryObject。 注意:索引鍵、不可變、不可為 Null、唯一。 |
objectType | Edm.String | GET | 識別此物件類型的字串。 對於服務端點,這個值一律是 "ServiceEndpoint"。 繼承自 DirectoryObject。 |
serviceId | Edm.String | POST、GET | 服務的識別碼 |
serviceName | Edm.String | POST、GET | 服務的顯示名稱。 |
URI | Edm.String | POST (必要), GET | 服務端點的 URI。 |
resourceId | Edm.String | POST、GET | 服務內特定資源的識別碼。 |
導覽屬性
無。
注意︰不支援未列出的繼承導覽屬性。 傳送到不支援之導覽屬性的要求會傳回「400 不正確的要求」****。
支援的作業
無法對服務端點直接執行作業。 您只能透過 Application 或 ServicePrincipal 的 serviceEndpoints 屬性來對其定址。 下列為支援的作業 (各項作業所使用的 HTTP 方法位於括弧內):
- 建立 (POST) -- 僅限於 Application 的 serviceEndpoints 導覽屬性。
- 讀取 (GET) -- 在 Application 或 ServicePrincipal 的 serviceEndpoints 導覽屬性上。
- 刪除 (DELETE) -- 僅限於 Application 的 serviceEndpoints 屬性。
在服務端點上無法呼叫任何函數或動作。
備註
- 當您將服務端點加入 Application 中時,需要 capability 和 uri 屬性。
ServicePrincipal 實體
代表目錄中的應用程式的執行個體。 繼承自 DirectoryObject。
屬性
宣告屬性
Name | 類型 | 支援 | 說明 |
---|---|---|---|
accountEnabled | Edm.Boolean | POST, GET ($filter), PATCH | 若已啟用服務主體帳戶,則為 true;否則為 false。 |
addIns | Collection(AddIn) | GET | 定義取用服務可用來在特定內容中呼叫應用程式的自訂行為。 例如,可以轉譯檔案資料流的應用程式可能會為其 "FileHandler" 功能設定 addIns 屬性。 這可讓如 Office 365 等服務在使用者目前正在處理的文件內容中呼叫應用程式。 注意:需要 1.6 版。 |
appDisplayName | Edm.String | GET | 相關聯應用程式所公開的顯示名稱。 |
appId | Edm.Guid | POST (必要), GET ($filter), PATCH | 相關聯應用程式的唯一識別碼 (其 appId 屬性)。 |
appOwnerTenantId | Edm.Guid | GET | |
appRoleAssignmentRequired | Edm.Boolean | POST, GET, PATCH | 指定在 Azure AD 核發使用者或存取權杖給應用程式之前,是否需要使用者或群組的 AppRoleAssignment。 注意:需要 1.5 版或更新版本,不可為 Null。 |
appRoles | Collection(AppRole) | GET | 相關聯應用程式所公開的應用程式角色。 如需詳細資訊,請參閱 Application 實體的 appRoles 屬性定義 注意:需要 1.5 版或更新版本,不可為 Null。 |
authenticationPolicy | ServicePrincipalAuthenticationPolicy | GET | 保留僅供內部使用。 請勿使用。 1.5 版中移除。 注意:只在 2013-11-08 版中可用。 |
deletionTimestamp | Edm.DateTime | GET | 此屬性對服務主體而言無效,一律會傳回 null。 繼承自 DirectoryObject。 注意:需要 1.5 版或更新版本。 |
displayName | Edm.String | POST, GET ($filter), PATCH | 服務主體的顯示名稱。 |
errorUrl | Edm.String | POST, GET, PATCH | |
首頁 | Edm.String | POST, GET, PATCH | 相關聯應用程式的首頁 URL。 |
keyCredentials | Collection(KeyCredential) | POST, GET, PATCH | 與服務主體相關聯的金鑰認證集合。 注意:不可為 Null。 |
logoutUrl | Edm.String | POST, GET, PATCH | |
oauth2Permissions | Collection(OAuth2Permission) | GET | 相關聯應用程式所公開的 OAuth 2.0 權限。 如需詳細資訊,請參閱 Application 實體的 oauth2Permissions 屬性定義。 注意:需要 1.5 版或更新版本,不可為 Null。 |
objectId | Edm.String | GET | 服務主體的唯一識別碼。 繼承自 DirectoryObject。 注意:索引鍵、不可變、不可為 Null、唯一。 |
objectType | Edm.String | GET | 識別此物件類型的字串。 對於服務主體,這個值一律是 "ServicePrincipal"。 繼承自 DirectoryObject。 |
passwordCredentials | Collection(PasswordCredential) | POST, GET, PATCH | 與服務主體相關聯的密碼認證集合。 注意:不可為 Null。 |
preferredTokenSigningKeyThumbprint | Edm.String | GET | 保留僅供內部使用。 請勿撰寫或依賴這個屬性。 可能會在未來版本中移除。 注意:需要 1.5 版或更新版本。 |
publisherName | Edm.String | POST, GET ($filter), PATCH | 租用戶的顯示名稱,其中指定相關聯的應用程式。 |
replyUrls | Collection(Edm.String) | POST, GET, PATCH | 為了供相關聯的應用程式登入而將使用者權杖傳送到的 URL,或為了存取相關聯的應用程式而將 OAuth 2.0 授權碼和存取權杖傳送到的重新導向 URL。 注意:不可為 Null。 |
samlMetadataUrl | Edm.String | POST, GET, PATCH | |
servicePrincipalNames | Collection(Edm.String) | POST, GET ($filter), PATCH | 用來識別相關聯應用程式的 URI。 如需詳細資訊,請參閱應用程式物件和服務主體物件。 注意︰不可為 Null,多重值屬性的篩選條件運算式需要 any 運算子;如需詳細資訊,請參閱Supported Queries, Filters, and Paging Options。 |
標記 | Collection(Edm.String) | POST, GET ($filter), PATCH | 注意:不可為 Null。 |
導覽屬性
Name | 收件者 | 多重性 (來源/目的地) |
說明 |
---|---|---|---|
appRoleAssignedTo | AppRoleAssignment | */* | 指派給此服務主體的主體 (使用者、群組和服務主體)。 需要 1.5 版或更新版本。 |
appRoleAssignments | AppRoleAssignment | */* | 服務主體指派到的應用程式。 需要 1.5 版或更新版本。 |
createdObjects | DirectoryObject | */* | 此服務主體所建立的目錄物件。 繼承自 DirectoryObject。 需要 2013-11-08 版本或更新版本。 |
memberOf | DirectoryObject (僅支援 DirectoryRole 和 Group 物件) |
*/* | 此服務主體為其直屬成員的角色和群組。 繼承自 DirectoryObject。 HTTP 方法:GET |
oauth2PermissionGrants | OAuth2PermissionGrant | */* | 與此服務主體相關聯的使用者模擬授權。 需要 1.5 版或更新版本。 |
ownedObjects | DirectoryObject | */* | 此服務主體所擁有的目錄物件。 繼承自 DirectoryObject。 需要 2013-11-08 版本或更新版本。 |
owners | DirectoryObject | */* | 做為此服務主體之擁有者的目錄物件。 擁有者是一組允許修改此物件的非系統管理員使用者。 繼承自 DirectoryObject。 需要 2013-11-08 版本或更新版本。 |
權限 | 權限 | */* | 在 1.5 版及更新版本中,已重新命名為 oauth2PermissionGrants。 在舊版中,指向與服務主體相關聯的權限。 如需 Permission 實體類型的資訊,請參閱 OAuth2PermissionGrant。 |
serviceEndpoints | serviceEndpoint | 1/* | 適用於探索的服務端點。 如需詳細資訊,請參閱 ServiceEndpoint 主題。 HTTP 方法:GET。 需要 1.6 版或更新版本。 |
注意︰不支援未列出的繼承導覽屬性。 傳送到不支援之導覽屬性的要求會傳回「400 不正確的要求」****。
支援的作業
下列為服務主體支援的作業 (各項作業所使用的 HTTP 方法位於括號內):
- 建立 (POST)
- 讀取 (GET)
- 更新 (PATCH)
- 刪除 (DELETE)
下列為導覽屬性支援的作業:
- 讀取 (GET)
在群組上可以呼叫下列動作和函數:
- checkMemberGroups 可檢查服務主體在群組清單中的成員資格。 此檢查可移轉。
- getMemberGroups 可傳回服務主體隸屬的群組清單。 此檢查可移轉。
- getMemberObjects 可傳回服務主體隸屬的群組和目錄角色清單。 此檢查可移轉。
主體必須是「公司系統管理員」角色,才能在服務主體上執行作業。
備註
當您建立服務主體時,您必須將 appId 屬性設為目錄中的應用程式識別碼。
SubscribedSku 實體
包含公司訂閱之服務 SKU 的相關資訊。
已訂閱的 SKU 僅支援讀取操作,不支援建立、更新和刪除。 不支援查詢篩選條件運算式。
屬性
宣告屬性
屬性 | 類型 | 支援 | 描述 |
---|---|---|---|
appliesTo | Edm.String | GET | 例如,「使用者」或「公司」。 注意:需要 1.6 版。 |
capabilityStatus | Edm.String | GET | 例如,「已啟用」。 |
consumedUnits | Edm.Int32 | GET | 已指派的授權數目。 |
objectId | Edm.String | GET | 已訂閱之 SKU 物件的唯一識別碼。 注意:索引鍵、不可為 Null。 |
prepaidUnits | LicenseUnitsDetail | GET | 預付授權數目和狀態的相關資訊。 |
servicePlans | Collection(ServicePlanInfo) | GET | SKU 可用之服務方案的相關資訊。 注意:不可為 Null。 |
skuId | Edm.Guid | GET | 服務 SKU 的唯一識別碼 (GUID)。 |
skuPartNumber | Edm.String | GET | SKU 組件編號,例如:"AAD_PREMIUM" 或 "RMSBASIC"。 |
導覽屬性
無。
注意︰不支援未列出的繼承導覽屬性。 傳送到不支援之導覽屬性的要求會傳回「400 不正確的要求」****。
支援的作業
下列為已訂用的 SKU 支援的作業 (各項作業所使用的 HTTP 方法位於括號內):
- 讀取 (GET)
已訂閱的 SKU 不公開任何導覽屬性。
在已訂閱的 SKU 上無法呼叫任何函數或動作。
TenantDetail 實體
代表 Azure Active Directory 租用戶。 租用戶上僅支援讀取和更新作業,不支援建立和刪除。 繼承自 [DirectoryOjbect]。
屬性
宣告屬性
Name | 類型 | 支援 | 說明 |
---|---|---|---|
assignedPlans | Collection(AssignedPlan) | GET | 與租用戶相關的服務方案集合。 注意:不可為 Null。 |
城市 | Edm.String | GET | |
companyLastDirSyncTime | Edm.DateTime | GET | 租用戶最後一次與內部部署目錄進行同步處理的時間和日期。 |
國家/地區 | Edm.String | GET | |
countryLetterCode | Edm.String | GET | |
deletionTimestamp | Edm.DateTime | GET | 此屬性對租用戶而言無效,一律會傳回 null。 繼承自 DirectoryObject。 注意:需要 1.5 版或更新版本。 |
dirSyncEnabled | Edm.Boolean | GET | 若此物件從內部部署目錄同步處理,則為 true;若此物件原本從內部部署目錄同步處理但已不再同步處理,則為 false;如果此物件從未自內部部署目錄同步處理 (預設值),則為 null。 |
displayName | Edm.String | GET | 租用戶的顯示名稱。 |
marketingNotificationEmails | Collection(Edm.String) | GET, PATCH | 注意:不可為 Null。 |
objectId | Edm.String | GET | 租用戶的唯一識別碼。 繼承自 DirectoryObject。 注意:索引鍵、不可變、不可為 Null、唯一。 |
objectType | Edm.String | GET | 識別此物件類型的字串。 對於租用戶,這個值一律是 "Company"。 繼承自 DirectoryObject。 |
postalCode | Edm.String | GET | |
preferredLanguage | Edm.String | GET | |
provisionedPlans | Collection(ProvisionedPlan) | GET | 注意:不可為 Null。 |
provisioningErrors | Collection(ProvisioningError) | GET | 注意:不可為 Null。 |
狀態 | Edm.String | GET | |
街道 | Edm.String | GET | |
technicalNotificationMails | Collection(Edm.String) | GET, PATCH | 注意:不可為 Null。 |
telephoneNumber | Edm.String | GET | |
tenantType | Edm.String | GET | 注意:1.5 版及更新版本中已移除。 |
verifiedDomains | Collection(VerifiedDomain) | GET | 與此租用戶相關的定義域集合。 注意:不可為 Null。 |
導覽屬性
Name | 收件者 | 目標多重性 | 說明 |
---|---|---|---|
trustedCAsForPasswordlessAuth | TrustedCAsForPasswordlessAuth | 1/1 | 執行無密碼驗證時用來驗證信任鏈結的一組憑證授權單位。 如需詳細資訊,請參閱備註。 注意:需要 1.6 版或更新版本。 |
注意︰不支援未列出的繼承導覽屬性。 傳送到不支援之導覽屬性的要求會傳回「400 不正確的要求」****。
支援的作業
下列為租用戶支援的作業 (各項作業所使用的 HTTP 方法位於括號內):
- 讀取 (GET)
- 更新 (PATCH);使用 Graph API 只能更新 marketingNotificationMails 和 technicalNotificationMails 屬性。
下列為租用戶導覽屬性支援的作業:
- 讀取 (GET)
- 更新 (POST)
- 刪除 (DELETE)
在租用戶上無法呼叫任何函數或動作。
備註
- 您無法使用 Graph API 建立或刪除租用戶。
- 使用 Graph API 只能更新 marketingNotificationMails 和 technicalNotificationMails 屬性。
- 受信任的憑證授權單位可讓同盟租用戶中的使用者使用憑證式驗證進行登入。 為了實現此案例,請設定 trustedCAsForPasswordlessAuth 導覽屬性,將憑證授權單位的公開憑證設定為受信任可以進行登入。
- 查詢篩選器運算式不支援租用戶。
TrustedCAsForPasswordlessAuth 實體
代表執行無密碼驗證時要驗證信任鏈結的一組憑證授權單位。
TenantDetail 實體的 TrustedCAsForPasswordlessAuth 導覽屬性是 trustedCAsForPasswordlessAuth 的集合。 用戶端可以使用此屬性,將授權單位的公開憑證設定為受信任可以進行登入,以便同盟租用戶中的使用者能夠使用憑證式驗證進行登入。
重要:在 1.6 版中引進。
屬性
宣告屬性
Name | 類型 | 支援 | 說明 |
---|---|---|---|
id | Edm.String | GET | 唯一識別碼。 注意:索引鍵、不可為 Null。 |
certificateAuthorities | Collection(CertificateAuthorityInformation) | POST (必要), GET, PATCH | 憑證授權單位資訊的集合。 |
導覽屬性
無。
支援的作業
下列為受信任的憑證授權單位支援的作業 (各項作業所使用的 HTTP 方法位於括弧內):
- 建立 (POST);只能指定 certificateAuthorities 屬性。
- 讀取 (GET)
- 更新 (PATCH);僅限 certificateAuthorities 屬性
受信任的憑證不公開任何導覽屬性。
在受信任的憑證授權單位上無法呼叫任何函數或動作。
User 實體
代表 Azure AD 使用者帳戶。 繼承自 DirectoryObject。
屬性
宣告屬性
Name | 類型 | 支援 | 說明 |
---|---|---|---|
accountEnabled | Edm.Boolean | POST (必要), GET ($filter), PATCH | 若已啟用帳戶,則為 true;否則為 false。 建立使用者時需要此屬性。 |
assignedLicenses | Collection(AssignedLicense) | POST, GET, PATCH | 指派給使用者的授權。 注意:不可為 Null。 |
assignedPlans | Collection(AssignedPlan) | GET | 指派給使用者的方案。 注意:不可為 Null。 |
城市 | Edm.String | POST, GET ($filter), PATCH | 使用者所在的縣市。 |
國家/地區 | Edm.String | POST, GET ($filter), PATCH | 使用者所在的國家/地區,例如 "US" 或 "UK"。 |
creationType | Edm.String | POST (本機帳戶的必要項), GET ($filter) | 指定使用者帳戶是否為 Azure Active Directory B2C 租用戶的本機帳戶。 可能的值為 "LocalAccount" 和 null。 建立本機帳戶時,需要此屬性,而且您必須將它設為 "LocalAccount"。 建立工作或學校帳戶時,請勿指定此屬性,或將它設為 null。 如需 Azure Active Directory B2C 的詳細資訊,請參閱 Azure Active Directory B2C 文件。 注意:需要 1.6 版或更新版本。 在搶鮮版 (Beta) 中,將值指定為 "NameCoexistence" 而非 "LocalAccount"。 |
deletionTimestamp | Edm.DateTime | GET | 此屬性對使用者而言無效,一律會傳回 null。 繼承自 DirectoryObject。 注意:需要 1.5 版或更新版本。 |
department | Edm.String | POST, GET ($filter), PATCH | 使用者工作的部門名稱。 |
dirSyncEnabled | Edm.Boolean | GET ($filter) | 若此物件從內部部署目錄同步處理,則為 true;若此物件原本從內部部署目錄同步處理但已不再同步處理,則為 false;如果此物件從未自內部部署目錄同步處理 (預設值),則為 null。 |
displayName | Edm.String | POST (必要), GET ($filter), PATCH (但無法清除) | 使用者顯示於通訊錄中的名稱。 這通常是使用者的名字、中間名縮寫和姓氏的組合。 建立使用者時需要此屬性,且在更新期間無法將其清除。 |
facsimileTelephoneNumber | Edm.String | POST, GET, PATCH | 使用者的商務傳真機電話號碼。 |
givenName | Edm.String | POST, GET ($filter), PATCH | 使用者的名字。 |
immutableId | Edm.String | POST (使用 UPN 的同盟網域時為必要項), GET ($filter), PATCH | 此屬性用來將內部部署 Active Directory 使用者帳戶與其 Azure AD 使用者物件產生關聯。 如果您使用使用者之 userPrincipalName (UPN) 屬性的同盟網域,在 Graph 中建立新使用者帳戶時,必須指定此屬性。 重要:指定此屬性時,無法使用 $ 和 _ 字元。 注意:需要 2013-11-08 版或更新版本。 |
jobTitle | Edm.String | POST, GET ($filter), PATCH | 使用者的職稱。 |
lastDirSyncTime | Edm.DateTime | GET ($filter) | 指出此物件上次與內部部署目錄進行同步處理的時間。例如:"2013-02-16T03:04:54Z" |
Edm.String | POST, GET ($filter) | 使用者的 SMTP 位址,例如 "jeff@contoso.onmicrosoft.com"。 | |
mailNickname | Edm.String | POST (工作或學校帳戶的必要項), GET ($filter), PATCH | 使用者的郵件別名。 當您建立工作或學校帳戶時,需要此屬性;對於本機帳戶而言則為選擇性。 |
行動 | Edm.String | POST, GET, PATCH | 使用者的主要行動電話號碼。 |
objectId | Edm.Guid | GET | 使用者的唯一識別碼。 繼承自 DirectoryObject。 注意:索引鍵、不可變、不可為 Null、唯一。 |
objectType | Edm.String | GET | 識別此物件類型的字串。 對於使用者,這個值一律是 "User"。 繼承自 DirectoryObject。 |
onPremisesSecurityIdentifier | Edm.String | GET | 包含已從內部部署同步至雲端之使用者的內部部署安全性識別碼 (SID)。 注意:需要 1.5 版或更新版本。 |
otherMails | Collection(Edm.String) | POST, GET ($filter), PATCH | 使用者的其他電子郵件地址清單,例如:["bob@contoso.com", "Robert@fabrikam.com"]。 注意︰不可為 Null,多重值屬性的篩選條件運算式需要 any 運算子;如需詳細資訊,請參閱Supported Queries, Filters, and Paging Options。 |
passwordPolicies | Edm.String | POST, GET, PATCH | 指定使用者的密碼原則。 這個值是一個列舉,具有可能值 "DisableStrongPassword" 允許指定比預設原則更弱的密碼。 也可以指定 "DisablePasswordExpiration"。 兩者可同時指定,例如:"DisablePasswordExpiration, DisableStrongPassword"。 |
passwordProfile | PasswordProfile | POST (必要), GET, PATCH | 指定使用者的密碼設定檔。 設定檔含有使用者的密碼。 建立使用者時需要此屬性。 設定檔內的密碼必須符合 passwordPolicies 屬性所指定的最低需求。 依預設需要增強式密碼。 如需強式密碼必須符合之各項限制的詳細資訊,請參閱 Microsoft Office 365 說明頁面中變更您的密碼底下的密碼原則。 |
physicalDeliveryOfficeName | Edm.String | POST, GET, PATCH | 使用者工作地點的辦公室位置。 |
postalCode | Edm.String | POST, GET, PATCH | 使用者郵寄地址的郵遞區號。 具體的郵遞區號依使用者的國家/地區而定。 在美國,此屬性包含了郵遞區號 (ZIP Code)。 |
preferredLanguage | Edm.String | POST, GET, PATCH | 使用者慣用的語言。 應該符合 ISO 639-1 代碼,例如 "en-US"。 |
provisionedPlans | Collection(ProvisionedPlan) | GET | 針對使用者佈建的方案。 注意:不可為 Null。 |
provisioningErrors | Collection(ProvisioningError) | GET | 導致無法成功佈建這名使用者之錯誤詳細資料的集合。 |
proxyAddresses | Collection(Edm.String) | GET ($filter) | Fpr 範例:["SMTP: bob@contoso.com", "smtp: bob@sales.contoso.com"] 注意︰唯一、不可為 Null,多重值屬性的篩選條件運算式需要 any 運算子;如需詳細資訊,請參閱Supported Queries, Filters, and Paging Options。 |
signInNames | Collection(SignInName) | POST (本機帳戶的必要項), GET ($filter) | 為 Azure Active Directory B2C 租用戶中的本機帳戶,指定登入名稱的集合。 每個登入名稱在公司/租用戶中必須是唯一的。 當您建立本機帳戶使用者時,必須指定此屬性;當您建立工作或學校帳戶時,則請勿指定。 如需 Azure Active Directory B2C 的詳細資訊,請參閱 Azure Active Directory B2C 文件。 注意:需要 1.6 版或更新版本。 已從搶鮮版 (Beta) 中的 alternativeSignInNameInfo 重新命名。 |
sipProxyAddress | Edm.String | GET | 指定使用者的 voice over IP (VOIP) 工作階段初始通訊協定 (SIP) 位址。 注意:需要 1.5 版或更新版本。 |
狀態 | Edm.String | POST, GET ($filter), PATCH | 使用者地址所屬的州/省。 |
streetAddress | Edm.String | POST, GET, PATCH | 使用者工作地點的街道地址。 |
surname | Edm.String | POST, GET ($filter), PATCH | 使用者的姓氏。 注意:可篩選。 |
telephoneNumber | Edm.String | POST, GET, PATCH | 使用者工作地點的主要電話號碼。 |
thumbnailPhoto | Edm.Stream | POST, GET, PATCH | 使用者的相片縮圖顯示。 注意:不可為 Null。 |
usageLocation | Edm.String | POST, GET ($filter), PATCH | 雙字母的國碼 (ISO 標準 3166)。 基於法律要求而必須檢查服務在國家或地區中的可用性,將獲派授權的使用者需要此項目。 範例包括:"US"、"JP" 和 "GB" 注意:不可為 Null。 |
userPrincipalName | Edm.String | POST (工作或學校帳戶的必要項), GET ($filter), PATCH | 使用者的使用者主要名稱 (UPN)。 UPN 是使用者的網際網路型態登入名稱 (根據網際網路標準 RFC 822)。 依照慣例,這應該對應到使用者的電子郵件名稱。 一般格式為 "alias@domain"。 若是工作或學校帳戶,此網域必須在租用戶的已驗證網域集合中。 建立工作或學校帳戶時,需要此屬性;對於本機帳戶而言則為選擇性。 租用戶的已驗證網域可透過 TenantDetail 的 VerifiedDomains 屬性存取。 注意:索引鍵、唯一。 |
userType | Edm.String | POST, GET ($filter), PATCH | 字串值可用來在您的目錄中分類使用者類型,例如 "Member" 和 "Guest"。 注意:需要 2013-11-08 版或更新版本。 |
導覽屬性
Name | 收件者 | 多重性 (來源/目的地) |
說明 |
---|---|---|---|
manager | DirectoryObject (僅支援 User 和 Contact 物件。) |
*/0..1 | 擔任這名使用者之管理員的使用者或連絡人。 繼承自 DirectoryObject。 HTTP 方法:GET、PUT、DELETE |
directReports | DirectoryObject (僅支援 User 和 Contact 物件。) |
*/* | 負責向這名使用者報告的使用者及連絡人。 (使用者及連絡人的 manager 屬性設定為這名使用者。)繼承自 DirectoryObject。 HTTP 方法:GET |
licenseDetails | LicenseDetail | */* | 注意:需要 1.6 版或更新版本。 |
memberOf | DirectoryObject (僅支援 Group 和 DirectoryRole 物件。) |
*/* | 使用者隸屬為其成員的群組及目錄角色。 繼承自 DirectoryObject。 HTTP 方法:GET |
ownedDevices | [裝置] | */* | 使用者所擁有的裝置。 |
權限 | 權限 | */* | 與使用者相關聯的權限。 在 1.5 版及更新版本中,此屬性已重新命名為 oauth2PermissionGrants而 Permission 實體已重新命名為 OAuth2PermissionGrant。 如需 Permission 實體類型的文件,請參閱 OAuth2PermssionGrant 的文件。 |
registeredDevices | [裝置] | */* | 使用者已註冊的裝置。 |
createdObjects | DirectoryObject | */* | 使用者建立的目錄物件。 需要 2013-11-08 版本或更新版本。 |
ownedObjects | DirectoryObject | */* | 使用者所擁有的目錄物件。 需要 2013-11-08 版本或更新版本。 |
appRoleAssignments | AppRoleAssignment | */* | 這個使用者指派到的應用程式集。 需要 1.5 版或更新版本。 HTTP 方法:GET、POST、DELETE |
oauth2PermissionGrants | OAuth2PermissionGrant | */* | 獲得同意模擬此使用者的應用程式集。 需要 1.5 版或更新版本。 HTTP 方法:GET、POST、DELETE |
注意︰不支援未列出的繼承導覽屬性。 傳送到不支援之導覽屬性的要求會傳回「400 不正確的要求」****。
支援的作業
下列為使用者支援的作業 (各項作業所使用的 HTTP 方法位於括號內):
- 建立 (POST)
- 讀取 (GET)
- 更新 (PATCH)
- 刪除 (DELETE)
使用者導覽屬性支援下列作業,並非每個導覽屬性都支援所有作業。
- 讀取 (GET)
- 更新 (PUT)
- 刪除 (DELETE)
在使用者上可以呼叫下列動作和函數:
- assignLicense 可指派及/或移除使用者的指定授權清單。 需要 2013-11-08 版本或更新版本。
- checkMemberGroups 可檢查使用者在群組清單中的成員資格。 此檢查可移轉。
- getAvailableExtensionProperties 可傳回使用者已註冊的擴充功能屬性清單。 需要 1.5 版或更新版本。
- getMemberGroups 可傳回使用者隸屬的群組清單。 此檢查可移轉。
- getMemberObjects 可傳回使用者隸屬的群組和目錄角色清單。 此檢查可移轉。
- isMemberOf 可檢查使用者是否為指定群組的成員。 此檢查可移轉。
備註
- 若要建立工作或學校帳戶,需要下列屬性︰accountEnabled、displayName、mailNickname、passwordProfile 和 userPrincipalName。 passwordProfile 屬性所指定的密碼必須符合租用戶的密碼複雜性需求。 如需詳細資訊,請參閱 passwordPolicies 屬性。
- 若要建立本機帳戶,需要下列屬性︰accountEnabled、creationType (必須設為 “LocalAccount”)、displayName、passwordProfile 和 signInNames。 passwordProfile 屬性所指定的密碼必須符合租用戶的密碼複雜性需求。 如需詳細資訊,請參閱 passwordPolicies 屬性。
- 在 2013-11-08 版及更新版本中,如果您使用使用者之 userPrincipalName (UPN) 屬性的同盟網域,在 Graph 中建立新使用者帳戶時,必須指定 immutableId 屬性。
- displayName 屬性在更新時無法清除。
- passwordProfile 屬性一律會傳回 null。 這是為了防止顯示使用者的密碼。 您可以藉由更新 passwordProfile 屬性重設使用者的密碼。
- 除了適用於所有目錄實體的標準定址之外,還可以使用 userPrincipalName 屬性來定址使用者,例如
https://graph.windows.net/contoso.onmicrosoft.com/users/john@contoso.onmicrosoft.com?api-version=1.5
。
複雜類型參考
AddIn 類型
定義取用服務可用來在特定內容中呼叫應用程式的自訂行為。 例如,可以轉譯檔案資料流的應用程式可能會為其 "FileHandler" 功能設定 addIns 屬性。 這可讓如 Office 365 等服務在使用者目前正在處理的文件內容中呼叫應用程式。 Application 和 ServicePrincipal 實體的 addins 屬性是 AddIn 的集合。
重要:在 1.6 版中引進。
屬性
Name | 類型 | 讀取/寫入 | 說明 |
---|---|---|---|
id | Edm.Guid | R | 特定 Application 上之 addins 集合內的唯一識別碼。 |
型別 | Edm.String | RW | 應用程式所公開之功能的唯一名稱。 |
內容 | Collection(KeyValue) | RW (寫入時為必要項) | 索引鍵/值組的集合,定義取用服務可使用或呼叫的參數。 對 addIns 集合執行 POST 或 PATCH 作業時,您必須指定此屬性。 |
AlternativeSecurityId 類型
包含與裝置相關聯的替代安全性識別碼。 Device 實體的 alternativeSecurityIds 屬性是 AlternativeSecurityId 的集合。
屬性
Name | 類型 | 讀取/寫入 | 說明 |
---|---|---|---|
identityProvider | Edm.String | ||
key | Edm.Binary | ||
型別 | Edm.Int32 |
AppRole 類型
代表應用程式角色,可能由呼叫另一個應用程式的用戶端應用程式要求,或用來將應用程式指派給指定應用程式角色中的使用者或群組。 ServicePrincipal 實體和 Application 實體的 appRoles 屬性是 AppRole 的集合。
重要:需要 1.5 版或更新版本。
屬性
Name | 類型 | 讀取/寫入 | 說明 |
---|---|---|---|
allowedMemberTypes | Collection(Edm.String) | RW | 指定是否可以藉由設定為 "User" 而將此應用程式角色定義指派給使用者和群組,或藉由設定為 "Application" 而指派給其他應用程式 (在精靈服務案例中存取此應用程式),或指派給使用者和群組以及其他應用程式。 注意:不可為 Null。 |
描述 | Edm.String | RW | 出現在管理員應用程式指派和同意體驗中的權限說明文字。 |
displayName | Edm.String | RW | 出現在管理員同意和應用程式指派體驗中的權限顯示名稱。 |
id | Edm.Guid | RW | appRoles 集合內的唯一角色識別碼。 |
isEnabled | Edm.Boolean | RW | 當建立或更新角色定義時,這必須設為 true (此為預設值)。 若要刪除角色,這必須先設為 false。 此時,在後續的呼叫中,可能會移除此角色。 |
值 | Edm.String | RW | 指定應用程式預期驗證和存取權杖中應該有的角色宣告值。 |
AssignedLicense 類型
代表指派給使用者的授權。 User 實體的 assignedLicenses 屬性是 AssignedLicense 的集合。
屬性
Name | 類型 | 讀取/寫入 | 說明 |
---|---|---|---|
disabledPlans | Collection(Edm.Guid) | R | 已停用之方案的唯一識別碼集合。 注意:不可為 Null。 |
skuId | Edm.Guid | R | 服務 SKU 的唯一識別碼。 與相關 SubscribedSku 物件的 skuId 屬性值相同。 |
AssignedPlan 類型
User 實體和 TenantDetail 實體的 assignedPlans 屬性是 AssignedPlan 的集合。
屬性
Name | 類型 | 讀取/寫入 | 說明 |
---|---|---|---|
assignedTimestamp | Edm.DateTime | R | 指派方案的日期和時間,例如:2013-01-02T19:32:30Z。 |
capabilityStatus | Edm.String | R | 例如,「已啟用」。 |
服務 | Edm.String | R | 名稱的服務,例如 "SharePoint"、"MicrosoftOffice" 或 "Exchange"。 |
servicePlanId | Edm.Guid | R | 識別服務方案的 GUID。 |
CertificateAuthorityInformation 類型
代表執行無密碼驗證時用來驗證信任鏈結的憑證授權單位。 TrustedCAsForPasswordlessAuth 實體的 CertificateAuthorities 屬性是 CertificateAuthorityInformation 的集合。
重要:在 1.6 版中引進。
屬性
Name | 類型 | 讀取/寫入 | 說明 |
---|---|---|---|
authorityType | Edm.String | RW (POST 時為必要項) | 必要。 必須設為兩個可能值的其中一個:“RootAuthority” 或 “IntermediateAuthority”。 可在驗證期間用來驗證憑證。 |
crlDistributionPoint | Edm.String | RW | 憑證撤銷清單 (CRL) 發佈點會保留儲存已撤銷之所有憑證序號的檔案。 這通常是 URI。 |
deltaCrlDistributionPoint | Edm.String | RW | 包含自上次建立完整 CRL 後所有已撤銷憑證之清單的 URI。 |
trustedCertificate | Edm.Binary | RW (POST 時為必要項) | 必要。 使用二進位格式的公開憑證。 |
trustedIssuer | Edm.String | R | 唯讀。 從 trustedCertificate 值計算而得。 |
trustedIssuerSki | Edm.String | R | 唯讀。 主體金鑰識別碼是從 trustedCertificate 值計算而得。 |
KeyCredential 類型
包含與應用程式或服務主體相關聯的金鑰認證。 Application 和 ServicePrincipal 實體的 keyCredentials 屬性是 KeyCredential 的集合。
屬性
Name | 類型 | 讀取/寫入 | 說明 |
---|---|---|---|
customKeyIdentifier | Edm.Binary | ||
endDate | Edm.DateTime | 認證過期的日期和時間。 | |
keyId | Edm.Guid | 金鑰的唯一識別碼 (GUID)。 | |
startDate | Edm.DateTime | 認證生效的日期和時間。 | |
型別 | Edm.String | 金鑰認證的類型,例如「對稱」。 | |
使用方式 | Edm.String | 描述金鑰用途的字串,例如「驗證」。 | |
值 | Edm.String |
KeyValue 類型
包含索引鍵/值組,定義取用服務可對 AddIn 中指定的應用程式使用或呼叫的參數。 AddIn 類型的 properties 屬性是 KeyValue 的集合。
重要:在 1.6 版中引進。
屬性
Name | 類型 | 讀取/寫入 | 說明 |
---|---|---|---|
key | Edm.String | RW | 索引鍵/值組的索引鍵。 |
值 | Edm.String | RW | 索引鍵/值組的值。 |
LicenseUnitsDetail 類型
包含公司訂閱的服務 SKU 之預付單位的相關資訊和狀態。
SubscribedSku 實體的 prepaidUnits 屬性屬於 LicenseUnitsDetail 類型。
屬性
Name | 類型 | 讀取/寫入 | 說明 |
---|---|---|---|
enabled | Edm.Int32 | R | 啟用的單位數。 |
已暫止 | Edm.Int32 | R | 暫止的單位數。 |
warning | Edm.Int32 | R | 處於警告狀態的單位數。 |
OAuth2Permission 類型
代表 OAuth 2.0 委派權限範圍。 用戶端應用程式在呼叫資源應用程式時,可要求指定的 OAuth 2.0 委派權限範圍 (透過 Application 物件上的 requiredResourceAccess 集合)。 ServicePrincipal 實體和 Application 實體的 oauth2Permissions 屬性是 OAuth2Permission 的集合。
重要:需要 1.5 版或更新版本。
屬性
Name | 類型 | 讀取/寫入 | 說明 |
---|---|---|---|
adminConsentDescription | Edm.String | RW | 出現在管理員同意和應用程式指派體驗中的權限說明文字。 |
adminConsentDisplayName | Edm.String | RW | 出現在管理員同意和應用程式指派體驗中的權限顯示名稱。 |
id | Edm. GUID | RW | Oauth2Permissions 集合內的唯一範圍權限識別碼。 |
isEnabled | Edm.Boolean | RW | 當建立或更新權限時,此屬性必須設為 true (此為預設值)。 若要刪除權限,此屬性必須先設為 false。 此時,在後續的呼叫中,可能會移除權限。 注意:不可為 Null。 |
型別 | Edm.String | RW | 指定此範圍權限是否可以由使用者同意,或它是否為必須由公司系統管理員同意的租用戶整體權限。 可能的值為 "User" 或 "Admin"。 |
userConsentDescription | Edm.String | RW | 出現在使用者同意體驗中的權限說明文字。 |
userConsentDisplayName | Edm.String | RW | 出現在使用者同意體驗中的權限顯示名稱。 |
值 | Edm.String | RW | 資源應用程式預期 OAuth 2.0 存取權杖中應該有的範圍宣告值。 |
PasswordCredential 類型
包含與應用程式或服務主體相關聯的密碼認證。 ServicePrincipal 實體和 Application 實體的 passwordCredentials 屬性是 PasswordCredential 的集合。
屬性
Name | 類型 | 讀取/寫入 | 說明 |
---|---|---|---|
customKeyIdentifier | Edm.Binary | ||
endDate | Edm.DateTime | 密碼過期的日期和時間。 | |
keyId | Edm.Guid | ||
startDate | Edm.DateTime | 密碼生效的日期和時間。 | |
值 | Edm.String |
PasswordProfile 類型
包含與使用者相關聯的密碼設定檔。 User 實體的 passwordProfile 屬性是 PasswordProfile 物件。
屬性
Name | 類型 | 附註 | 說明 |
---|---|---|---|
密碼 | Edm.String | RW | 使用者的密碼。 建立使用者時需要此屬性。 此屬性可加以更新,但使用者必須在下一次登入時變更密碼。 密碼必須符合使用者的 PasswordPolicies 屬性所指定的最低需求。 依預設需要增強式密碼。 |
forceChangePasswordNextLogin | Edm.Boolean | RW | 若使用者必須在下一次登入時變更其密碼,則為 true;否則為 false。 |
ProvisionedPlan 類型
User 實體和 TenantDetail 實體的 provisionedPlans 屬性是 ProvisionedPlan 的集合。
屬性
Name | 類型 | 讀取/寫入 | 說明 |
---|---|---|---|
capabilityStatus | Edm.String | R | 例如,「已啟用」或「已刪除」。 |
provisioningStatus | Edm.String | R | 例如,「成功」。 |
服務 | Edm.String | R | 名稱的服務,例如 "SharePoint"、"MicrosoftOffice" 或 "Exchange"。 |
ProvisioningError 類型
Contact、User 和 Group 實體的 provisioningErrors 屬性是 ProvisioningError 的集合。
屬性
Name | 類型 | 讀取/寫入 | 說明 |
---|---|---|---|
errorDetail | Edm.String | R | 錯誤的描述。 |
已解決 | Edm.Boolean | R | 若已解決錯誤,則為 true;否則為 false。 |
serviceInstance | Edm.String | R | 發生錯誤的服務執行個體。 |
時間戳記 | Edm.DateTime | R | 發生錯誤的日期和時間。 |
RequiredResourceAccess 類型
指定應用程式需要存取之指定資源下的 OAuth 2.0 權限範圍和應用程式角色集合。 用戶端應用程式在呼叫資源應用程式時,可要求指定的 OAuth 2.0 權限範圍 (透過 requiredResourceAccess 集合)。 Application 實體的 RequiredResourceAccess 屬性是 ReqiredResourceAccess 的集合。
重要:需要 1.5 版或更新版本。
屬性
Name | 類型 | 讀取/寫入 | 說明 |
---|---|---|---|
resourceAppId | Edm.String | RW | 應用程式需要存取之資源的唯一識別碼。 這應該等同於目標資源應用程式上宣告的 appId。 |
resourceAccess | Collection(ResourceAccess) | RW | 應用程式從指定的資源中需要的 OAuth2.0 權限範圍和應用程式角色清單。 注意:不可為 Null。 |
ResourceAccess 類型
指定應用程式需要的 OAuth 2.0 權限範圍或應用程式角色。 RequiredResourceAccess 類型的 resourceAccess 屬性是 ResourceAccess 的集合。
重要:需要 1.5 版或更新版本。
屬性
Name | 類型 | 讀取/寫入 | 說明 |
---|---|---|---|
id | Edm.Guid | RW | 資源應用程式所公開之 OAuth2Permission 或 AppRole 執行個體的唯一識別碼。 注意:不可為 Null。 |
型別 | Edm.String | RW | 指定 id 屬性參考 OAuth2Permission 或 AppRole。 可能的值為 "scope" 或 "role"。 |
ServicePlanInfo 類型
包含與訂閱的 SKU 相關聯之服務方案或指派給使用者之授權的相關資訊。 SubscribedSku 和 LicenseDetail 實體的 servicePlans 屬性是 ServicePlanInfo 的集合。
屬性
Name | 類型 | 讀取/寫入 | 說明 |
---|---|---|---|
appliesTo | Edm.String | R | 例如,「使用者」或「公司」。 注意:需要 1.6 版。 |
provisioningStatus | Edm.String | R | 例如,「成功」或「已停用」。 注意:需要 1.6 版。 |
servicePlanId | Edm.Guid | R | 服務方案的唯一識別碼 (GUID)。 |
servicePlanName | Edm.String | R | 服務方案的名稱。 例如,"MFA_PREMIUM"、"AAD_PREMIUM" 或 "RMS_S_BASIC"。 |
ServicePrincipalAuthenticationPolicy 類型
包含服務主體的驗證原則。
重要:只在 2013-11-08 中可用,但保留供內部使用,且已在 1.5 版及更新版本中移除。
屬性
Name | 類型 | 讀取/寫入 | 說明 |
---|---|---|---|
defaultPolicy | Edm.String | RW | 保留僅供內部使用。 請勿使用。 1.5 版中移除。 |
allowedPolicies | Collection(Edm.String) | RW | 保留僅供內部使用。 請勿使用。 1.5 版中移除。 注意:不可為 Null。 |
SignInName 類型
包含 Azure Active Directory B2C 租用戶中本機帳戶使用者之登入名稱的相關資訊。 User 實體的 signInNames 屬性是 SignInName 的集合。 如需 Azure Active Directory B2C 的詳細資訊,請參閱 Azure Active Directory B2C 文件。
重要:在 1.6 版中引進。 已從搶鮮版 (Beta) 中的 LogonIdentifier 重新命名。
屬性
Name | 類型 | 讀取/寫入 | 說明 |
---|---|---|---|
型別 | Edm.String | RW | 字串值可用來在您的目錄中分類使用者登入類型,例如 "emailAddress" 或 "userName"。 |
值 | Edm.String | RW | 本機帳戶使用的登入資訊。 在公司/租用戶中必須是唯一的。 例如,"johnc@example.com"。 |
VerifiedDomain 類型
指定租用戶的網域。 TenantDetail 實體的 verifiedDomains 屬性是 VerifiedDomain 的集合。
屬性
Name | 類型 | 讀取/寫入 | 說明 |
---|---|---|---|
capabilities | Edm.String | R | 例如,"Email"、"OfficeCommunicationsOnline"。 |
預設 | Edm.Boolean | R | 若這是與租用戶相關聯的預設網域,則為 true;否則為 false。 |
id | Edm.String | R | 例如,"00057FFE80187238"。 |
初始 | Edm.Boolean | R | |
名稱 | Edm.String | R | 網域名稱,例如 "contoso.onmicrosoft.com" |
型別 | Edm.String | R | 例如,"Managed"。 |
其他資源
- 在 Graph API 概念中深入了解 Graph API 支援的功能、能力和預覽功能。