servicePrincipal memberOf を一覧表示する
名前空間: microsoft.graph
この servicePrincipal がダイレクト メンバーになっているグループおよびディレクトリ ロールを取得します。 この操作は推移的ではありません。
この API は、次の国内クラウド展開で使用できます。
グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
---|---|---|
委任 (職場または学校のアカウント) | Application.Read.All | Application.ReadWrite.All、Directory.Read.All、Directory.ReadWrite.All |
委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
アプリケーション | Application.Read.All | Application.ReadWrite.All、Application.ReadWrite.OwnedBy、Directory.Read.All、Directory.ReadWrite.All |
重要
アプリケーションが directoryObject 型コレクションを返すリレーションシップを照会するときに、特定のリソースの種類を読み取るアクセス許可がない場合、その型のメンバーは返されますが、情報は限られています。 たとえば、オブジェクト型と id の @odata.type プロパティのみが返されますが、他のプロパティは としてnull
示されます。 この動作により、アプリケーションはディレクトリのセットに依存するのではなく、必要な最小限の特権のアクセス許可を要求できます 。*アクセス 許可。 詳細については、「アクセスできないメンバー オブジェクトについて、限定された情報が返される」を参照してください。
HTTP 要求
サービス プリンシパルは、 その ID または appId を使用してアドレス指定できます。 id と appId は、Microsoft Entra 管理センターのアプリ登録でそれぞれオブジェクト ID とアプリケーション (クライアント) ID と呼ばれます。
GET /servicePrincipals/{id}/memberOf
GET /servicePrincipals(appId='{appId}')/memberOf
オプションのクエリ パラメーター
このメソッドは、応答をカスタマイズするための$select
、$search
、および$count
を含むOData クエリ パラメーターをサポートします。 また、OData キャストも有効です。たとえば、ユーザーが属する directoryRoles のみを取得することができます。
displayName プロパティと description プロパティで $search
を使用できます。 既定のページ サイズと最大ページ サイズはそれぞれ 100 オブジェクトと 999 オブジェクトです。
要求ヘッダー
名前 | 説明 |
---|---|
Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
ConsistencyLevel | 最終的。 このヘッダーおよび$count は、$search 、$filter 、$orderby 、または OData キャスト クエリ パラメーターを使用する場合に必要です。 最新の状態に更新されていない可能性があるインデックスを使用しています。 |
要求本文
このメソッドには、要求本文を指定しません。
応答
成功した場合、このメソッドでは 200 OK
応答コードと、応答本文で directoryObject オブジェクトのコレクションを返します。
例
例 1: このサービス プリンシパルがダイレクト メンバーになっているグループおよびディレクトリ ロールを取得します
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/v1.0/servicePrincipals/00063ffc-54e9-405d-b8f3-56124728e051/memberOf
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"@odata.type": "#microsoft.graph.group",
"id": "id-value",
"createdDateTime": null,
"description": "All users at the company",
"displayName": "All Users",
"groupTypes": [],
"mailEnabled": false,
"securityEnabled": true
}
]
}
例 2: 全メンバーシップ数のみを取得する
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/v1.0/servicePrincipals/{id}/memberOf/$count
ConsistencyLevel: eventual
応答
次の例は応答を示しています。
HTTP/1.1 200 OK
Content-type: text/plain
394
例 3: OData キャストを使用して、グループ メンバーシップ数のみを取得する
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/v1.0/servicePrincipals/{id}/memberOf/microsoft.graph.group/$count
ConsistencyLevel: eventual
応答
次の例は応答を示しています。
HTTP/1.1 200 OK
Content-type: text/plain
394
例 4: $search および OData キャストを使用して、表示名に「Video」の文字が含まれるグループ メンバーシップを取得する (返されたオブジェクトの数も含む)
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/v1.0/servicePrincipals/{id}/memberOf/microsoft.graph.group?$count=true&$orderby=displayName&$search="displayName:Video"
ConsistencyLevel: eventual
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/v1.0/$metadata#directoryObjects",
"@odata.count":1396,
"value": [
{
"@odata.type": "#microsoft.graph.group",
"id": "id-value",
"createdDateTime": null,
"description": "All videos for the company",
"displayName": "All Videos",
"groupTypes": [],
"mailEnabled": false,
"securityEnabled": true
}
]
}
例 5: $filter および OData キャストを使用して、「A」で始まる表示名のグループ メンバーシップを取得する (返されたオブジェクトの数も含む)
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/v1.0/servicePrincipals/{id}/memberOf/microsoft.graph.group?$count=true&$orderby=displayName&$filter=startswith(displayName, 'A')
ConsistencyLevel: eventual
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/v1.0/$metadata#directoryObjects",
"@odata.count":76,
"value":[
{
"@odata.type": "#microsoft.graph.group",
"id": "id-value",
"createdDateTime": null,
"description": "All videos for the company",
"displayName": "All Videos",
"groupTypes": [],
"mailEnabled": false,
"securityEnabled": true
}
]
}