アプリケーションを一覧表示する
名前空間: microsoft.graph
重要
Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。
この組織内のアプリケーションの一覧を取得します。
注意
個人用 Microsoft アカウントに対して発行されたトークンを使ってこの API を呼び出すと、個人用 Microsoft アカウントが所有するアプリが返されます。 個人用 Microsoft アカウントでは、組織の概念はありません。 特定の個人用 Microsoft アカウントが所有しているアプリケーションを一覧表示するには、この API には Application.Read.All または Application.ReadWrite.All だけでなく、User.Read アクセス許可が必要です。
アクセス許可
この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。
| アクセス許可の種類 | アクセス許可 (特権の小さいものから大きいものへ) |
|---|---|
| 委任 (職場または学校のアカウント) | Application.Read.All、Application.ReadWrite.All、Directory.Read.All、Directory.ReadWrite.All |
| 委任 (個人用 Microsoft アカウント) | Application.Read.All、User.Read、Application.ReadWrite.All、User.Read |
| アプリケーション | Application.Read.All、Application.ReadWrite.All、Application.ReadWrite.OwnedBy、Directory.Read.All |
HTTP 要求
GET /applications
オプションのクエリ パラメーター
このメソッドは、応答をカスタマイズするための $count、$expand、$filter、$orderBy、$search、$select、および $top OData クエリ パラメーターをサポートします。 既定のページ サイズと最大ページ サイズは、それぞれ 100 と 999 のアプリケーション オブジェクトです。 クエリの中には、ConsistencyLevel ヘッダーの設定を eventual および $count に使用した場合にのみサポートされるものもあります。 詳細については、「Azure AD ディレクトリ オブジェクトの詳細クエリ機能」を参照してください。
既定では、この API は、すべてのアプリケーションを一覧表示するときに、keyCredentials プロパティに キー 拇印の値を返しません。 キー 拇印を取得するには、keyCredentials プロパティは、$select クエリで指定する必要があります。 たとえば、$select=id,appId,keyCredentials などです。
アプリケーションで $select を使用して keyCredentials を取得するには、テナントごとに 1 分あたり 150 要求の調整制限があります。
要求ヘッダー
| 名前 | 説明 |
|---|---|
| Authorization | ベアラー {token}。必須。 |
| ConsistencyLevel | 最終的。 このヘッダーと $count は、$search を使用する場合、または $filter の特別な使用をする場合に必要です。 ConsistencyLevel および $count の使用方法の詳細については、「Azure AD ディレクトリ オブジェクトの詳細クエリ機能」を参照してください。 |
要求本文
このメソッドには、要求本文を指定しません。
応答
成功した場合、このメソッドは 200 OK 応答コードと、応答本文で application オブジェクトのコレクションを返します。
例
例 1: アプリケーションの一覧を取得する
要求
以下は、要求の例です。
GET https://graph.microsoft.com/beta/applications
応答
以下は、応答の例です。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#applications",
"value": [
{
"appId": "00000000-0000-0000-0000-000000000000",
"identifierUris": [ "http://contoso/" ],
"displayName": "My app",
"publisherDomain": "contoso.com",
"signInAudience": "AzureADMyOrg"
}
]
}
例 2: アプリケーション数のみを取得する
要求
要求の例を次に示します。 この要求では、$count が要求にあるため、ConsistencyLevel ヘッダーを eventual に設定する必要があります。 ConsistencyLevel および $count の使用方法の詳細については、「Azure AD ディレクトリ オブジェクトの詳細クエリ機能」を参照してください。
注:
$countおよび$searchのクエリパラメーターは、現在 Azure ADB2C テナントでは使用できません。
GET https://graph.microsoft.com/beta/applications/$count
ConsistencyLevel: eventual
応答
応答の例を次に示します。
HTTP/1.1 200 OK
Content-type: text/plain
893
例 3: $filter と $top を使用して、「a」で始まる表示名のアプリケーションを 1 つ取得する (返されたオブジェクトの数も含む)
要求
要求の例を次に示します。 この要求では、$orderBy と $filter の両方のクエリ パラメーターがあるため、ConsistencyLevel ヘッダーを eventual および $count=true クエリ文字列に設定することが必要です。 ConsistencyLevel および $count の使用方法の詳細については、「Azure AD ディレクトリ オブジェクトの詳細クエリ機能」を参照してください。
注:
$countおよび$searchのクエリパラメーターは、現在 Azure ADB2C テナントでは使用できません。
GET https://graph.microsoft.com/beta/applications?$filter=startswith(displayName, 'a')&$count=true&$top=1&$orderby=displayName
ConsistencyLevel: eventual
応答
応答の例を次に示します。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#applications",
"@odata.count":1,
"value":[
{
"appId": "00000000-0000-0000-0000-000000000000",
"identifierUris": [ "http://contoso/" ],
"displayName":"a",
"publisherDomain": "contoso.com",
"signInAudience": "AzureADMyOrg"
}
]
}
例 4: $search を使用して、表示名に「Web」の文字が含まれるアプリケーションを取得する (返されたオブジェクトの数も含む)
要求
要求の例を次に示します。 この要求では、$search と $count=true のクエリ文字列が要求内にあるため、ConsistencyLevel ヘッダーを eventual に設定する必要があります。 ConsistencyLevel および $count の使用方法の詳細については、「Azure AD ディレクトリ オブジェクトの詳細クエリ機能」を参照してください。
注:
$countおよび$searchのクエリパラメーターは、現在 Azure ADB2C テナントでは使用できません。
GET https://graph.microsoft.com/beta/applications?$search="displayName:Web"&$count=true
ConsistencyLevel: eventual
応答
応答の例を次に示します。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#applications",
"@odata.count":1396,
"value":[
{
"appId": "00000000-0000-0000-0000-000000000000",
"identifierUris": [ "http://contoso/" ],
"displayName":"'DotNetWeb-App' ",
"publisherDomain": "contoso.com",
"signInAudience": "AzureADMyOrg"
}
]
}
フィードバック
フィードバックの送信と表示