List sponsors
名前空間: microsoft.graph
重要
Microsoft Graph の /beta
バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
ユーザーのスポンサーを取得します。 スポンサーは、テナント内のこのゲストの特権と、ゲストの情報とアクセスを最新の状態に保つために責任を負うユーザーとグループです。
この API は、次の国内クラウド展開で使用できます。
グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
---|---|---|
委任 (職場または学校のアカウント) | User.Read | User.ReadWrite.All、User.Read.All |
委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
アプリケーション | User.Read.All | User.ReadWrite.All |
重要
アプリケーションが directoryObject 型のコレクションを返すリレーションシップをクエリするときに、特定のリソース型を読み取るアクセス許可がない場合、その型のメンバーが返されますが、情報は限られます。 たとえば、@odata.type プロパティでは、オブジェクト型と ID だけが返され、その他のプロパティは null
と表示されます。 この動作により、アプリケーションは、Directory.* 権限が付与されたアクセス許可のセットに依存するのではなく、必要な最小限のアクセス許可を要求できます。 詳細については、「アクセスできないメンバー オブジェクトについて、限定された情報が返される」を参照してください。
重要
職場または学校アカウントを使用する委任されたシナリオでは、サインインしているユーザーに、サポートされているMicrosoft Entraロールまたはmicrosoft.directory/users/sponsors/read
ロールのアクセス許可を持つカスタム ロールを割り当てる必要があります。 この操作では、次の最小特権ロールがサポートされています。
- ゲスト招待者
- ディレクトリ リーダー
- ディレクトリ製作者
- ユーザー管理者
HTTP 要求
スポンサーを取得します。
GET /users/{id | userPrincipalName}/sponsors
オプションのクエリ パラメーター
このメソッドは、応答をカスタマイズするための $select
および $expand
OData クエリ パラメーターをサポートします。
$expand
内の$select
を指定して、個々のスポンサーのプロパティ ($expand=sponsors($select=id,displayName)
) を選択できます。
要求ヘッダー
ヘッダー | 値 |
---|---|
Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
要求本文
このメソッドには、要求本文を指定しません。
応答
成功した場合、このメソッドは 200 OK
応答コードと、応答本文の ユーザー オブジェクトと グループ オブジェクトのコレクションを返します。
例
要求
次の例は、スポンサーを取得する要求を示しています。
GET https://graph.microsoft.com/beta/users/025e5e3e-e5b7-4eb4-ba1f-4e5b0579f1a2/sponsors
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#directoryObjects",
"value": [
{
"@odata.type": "#microsoft.graph.user",
"id": "263a1289-8282-4bf7-91f7-550d9bba8c02",
"displayName": "Sara Davis",
"jobTitle": "Finance VP",
"mail": "SaraD@contoso.com",
"userPrincipalName": "SaraD@contoso.com"
},
{
"@odata.type": "#microsoft.graph.group",
"id": "08143e93-989e-4771-ac78-803bcdac52d2",
"mail": "groupforsponsors@contoso.com",
"mailEnabled": true,
"mailNickname": "groupforsponsors",
"securityEnabled": true
}
]
}