アプリケーション リソースの種類

  • [アーティクル]

名前空間: microsoft.graph

これはアプリケーションを表すものです。 Azure Active Directory (Azure AD) に認証をアウトソースするすべてのアプリケーションは、ディレクトリに登録する必要があります。 アプリケーションの登録では、アプリケーションに関する情報 (場所の URL、認証後に返信を送信する URL、アプリケーションを識別する URI など) を Azure AD に通知する必要があります。 詳細については、Azure AD でのアプリケーションの登録の基本を参照してください。 directoryObject から継承します。

このリソースは、デルタ関数を提供することによって、増分の追加、削除、および更新を追跡するためのデルタ クエリの使用をサポートしています。 このリソースは、他のプロパティを渡すことができるオープン型です。

メソッド

メソッド 戻り値の型 説明
アプリケーションを一覧表示する application コレクション 組織内のアプリケーションの一覧を取得します。
アプリケーションを作成する application 新しいアプリケーションを作成 (登録) します。
アプリケーションを取得する application application オブジェクトのプロパティと関係を読み取ります。
アプリケーションを更新する なし アプリケーション オブジェクトを更新します。
アプリケーションを削除する なし アプリケーション オブジェクトを削除します。
差分を取得する application リソース コレクション全体を完全に読み取ることなく、新しく作成、更新、または削除されたアプリケーションを取得します。
削除したアプリケーションを一覧表示する directoryObject コレクション 最近削除したアプリケーションの一覧を取得します。
ユーザーによって所有される削除したアプリケーションを一覧表示する directoryObject コレクション 過去 30 日間にテナントで削除され、ユーザーによって所有されているアプリケーションを取得します。
削除したアプリケーションを取得する directoryObject 最近削除したアプリケーションのプロパティを取得します。
アプリケーションを完全に削除する なし アプリケーションを完全に削除します。
削除したアプリケーションを復元する directoryObject 最近削除したアプリケーションを復元します。
証明書とシークレット
パスワードを追加する passwordCredential アプリケーションに強力なパスワードを追加します。
パスワードを削除する passwordCredential アプリケーションからパスワードを削除します。
キーの追加 keyCredential アプリケーションにキーの資格情報を追加します。
キーの削除 なし アプリケーションからキーの資格情報を削除します。
拡張機能
拡張を一覧表示する extensionProperty コレクション application オブジェクトの拡張プロパティを一覧表示します。
拡張を作成する extensionProperty application オブジェクトの拡張プロパティを作成します。
拡張を削除する なし application オブジェクトから拡張プロパティを削除します。
使用可能な拡張機能プロパティを取得する extensionProperty コレクション ディレクトリに登録されているディレクトリ拡張プロパティのすべてまたはフィルタリングされたリストを取得します。
所有者
所有者を一覧表示する directoryObject コレクション 所有者オブジェクトのコレクションを取得します。
Add owner directoryObject owners コレクションにポストすることで所有者を追加します。
所有者を削除する なし アプリケーションから所有者を削除します。
ポリシー
tokenIssuancePolicy を割り当てる tokenIssuancePolicy コレクション このオブジェクトに tokenIssuancePolicy を割り当てます。
tokenIssuancePolicy を一覧表示する tokenIssuancePolicy コレクション このオブジェクトに割り当てられているすべての tokenIssuancePolicy を取得します。
tokenIssuancePolicy を削除する tokenIssuancePolicy コレクション このオブジェクトから tokenIssuancePolicy を削除します。
tokenLifetimePolicy を割り当てる tokenLifetimePolicy コレクション このオブジェクトに tokenLifetimePolicy を割り当てます。
tokenLifetimePolicy を一覧表示する tokenLifetimePolicy コレクション このオブジェクトに割り当てられているすべての tokenLifetimePolicy を取得します。
tokenLifetimePolicy を削除する tokenLifetimePolicy コレクション このオブジェクトから tokenLifetimePolicy を削除します。
認証済発行元
認証済発行元を設定する なし アプリケーションの認証済みの発行元を設定する。
認証済発行元の設定を解除する なし アプリケーションの認証済み発行元を解除します。

プロパティ

重要

$filter および $search クエリ パラメーターの具体的な使用方法は、ConsistencyLevel ヘッダーの設定を eventual と $count に使用する場合にのみサポートされます。 詳細については、「Azure AD ディレクトリ オブジェクトの詳細クエリ機能」を参照してください。

プロパティ 種類 説明
addIns addIn コレクション 特定のコンテキストで利用者サービスがアプリを呼び出すために使用できるカスタムの動作を定義します。 たとえば、ファイル ストリームのレダリングが可能なアプリケーションは、そのアプリケーションの "FileHandler" 機能のために addIns プロパティを設定することがあります。 これにより、Office 365 などのサービスはユーザーが作業しているドキュメントのコンテキストでアプリケーションを呼び出せるようになります。
api apiApplication Web API を実装するアプリケーションの設定を指定します。
appId String Azure AD によって割り当てられたアプリケーションの一意の識別子。null 許容型ではありません。読み取り専用です。
applicationTemplateId String applicationTemplate の一意識別子です。 $filter (eq、not、ne) をサポートします。
appRoles appRole コレクション アプリケーションによって割り当てられたロールのコレクション。 アプリ ロールの割り当てを使用して、ユーザー、グループ、または他のアプリケーションのサービス プリンシパルにロールを割り当てることができます。 null 許容ではありません。
createdDateTime DateTimeOffset アプリケーションが登録された日付と時刻です。DateTimeOffset 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時間です。たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は 2014-01-01T00:00:00Z になります。読み取り専用。

$filter (eq、ne、not、ge、le、in、および eq の null値)、および $orderBy をサポートします。
deletedDateTime DateTimeOffset アプリケーションが削除された日付と時刻です。DateTimeOffset 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時間です。たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は 2014-01-01T00:00:00Z になります。読み取り専用。
description String アプリケーション オブジェクトの説明をエンド ユーザーに提供するフリー テキスト フィールド。 最大許容サイズは 1024 文字です。 $filter (eq、ne、not、ge、le、startsWith、$search) をサポートします。
disabledByMicrosoftStatus String Microsoft で登録済みアプリケーションを無効にしたかどうかを指定します。使用可能な値は、null (既定値)、NotDisabled、DisabledDueToViolationOfServicesAgreement です (疑わしいアクティビティ、悪用されたアクティビティ、悪意のあるアクティビティ、またはMicrosoft サービス規約の違反が理由になります)。

$filter (eq、ne、not) をサポートします。
displayName String アプリケーションの表示名。 $filter (eq、ne、not、ge、le、in、startsWith、および eq の null値)、$search、および $orderBy をサポートします。
groupMembershipClaims String アプリケーションが期待する、ユーザーまたは OAuth 2.0 アクセス トークンで発行される groups 要求を構成します。この属性を設定するには、次のいずれかの有効な文字列値を使用します: None、SecurityGroup (セキュリティ グループと Azure AD ロールの場合)、All (これにより、サインインしたユーザーがメンバーになっているすべてのセキュリティ グループ、配布グループ、および Azure AD ディレクトリ ロールが取得されます)。
id String アプリケーションの一意の識別子。directoryObject から継承されます。キー。null 許容ではありません。読み取り専用です。$filter (eq、ne、not、in) をサポートします。
identifierUris String collection アプリ ID URI とも呼ばれるこの値は、アプリケーションがリソース アプリとして使用される場合に設定されます。 identifierUris は、API のコードで参照するスコープのプレフィックスとして機能し、グローバルに一意である必要があります。 指定されたフォーム内の既定値を使用するかapi://<application-client-id>、次のような読み取り可能な URI を指定できます https://contoso.com/api。 有効な identifierUris パターンとベスト プラクティスの詳細については、Azure AD アプリケーションベスト プラクティスを参照してください。 null 許容ではありません。

$filter (eq、ne、ge、le、startsWith) をサポートしています。
info informationalUrl アプリケーションの基本プロファイル情報。アプリのマーケティング、サポート、サービス利用規約とプライバシーに関する声明の URL など。 サービス利用規約とプライバシーに関する声明は、ユーザーの同意エクスペリエンスからユーザーに提示されます。 詳細については、「方法: アプリのサービス利用規約とプライバシーに関する声明を構成する」を参照してください。

$filter (eq、ne、not、ge、le、および< eqの null値)をサポートします。
isDeviceOnlyAuthSupported Boolean このアプリケーションがユーザーなしのデバイス認証をサポートするかどうかを指定します。既定値は false です。
isFallbackPublicClient Boolean モバイル デバイスで実行するインストール済みアプリケーションなど、フォールバック アプリケーションの種類をパブリック クライアントとして指定します。 既定値は false です。これは、フォールバック アプリケーションの種類が、Web アプリなどの機密性の高いクライアントであることを意味します。 Azure AD がクライアントアプリケーションの種類を特定できないシナリオがあります。 たとえば、ROPCでは、リダイレクト URI を指定せずに構成するフローがあります。 そのような場合、Azure AD では、このプロパティの値に基づいて、アプリケーションの種類を解釈します。
keyCredentials keyCredential コレクション アプリケーションに関連付けられているキー資格情報のコレクションです。null 許容型ではありません。$filter (eq、not、ge、le) をサポートします。
logo Stream アプリケーションのメイン ロゴです。null 許容型ではありません。
notes String アプリケーションの管理に関連するメモです。
oauth2RequiredPostResponse ブール値 OAuth 2.0 トークン要求の一部として、Azure AD が GET 要求に対して POST 要求を許可するかどうかを指定します。 既定値はfalseです。これは、GET 要求のみが許可されるよう指定します。
optionalClaims optionalClaims アプリケーションの開発者は、Azure AD アプリにオプションの要求を構成することで、Microsoft セキュリティ トークン サービスからアプリに送信される要求を指定できます。詳細については、「方法: アプリにオプションの要求を提供する」を参照してください。
parentalControlSettings parentalControlSettings アプリケーションにおける、保護者による制限設定を指定します。
passwordCredentials passwordCredential コレクション アプリケーションに関連付けられているキー資格情報のコレクションです。null 許容型ではありません。
publicClient publicClientApplication デスクトップやモバイル デバイスなど、インストールされているクライアントの設定を指定します。
publisherDomain String アプリケーションの確認済み発行元のドメインです。 読み取り専用です。 詳細については、「方法: アプリケーションの発行元ドメインを構成する」を参照してください。 $filter (eq、ne、ge、le、startsWith) をサポートします。
requiredResourceAccess requiredResourceAccess コレクション アプリケーションがアクセスする必要があるリソースを指定します。 このプロパティでは、各リソースに必要な委任されたアクセス許可とアプリケーション ロールのセットも指定します。 必要なリソースへのアクセスに対するこの構成によって、同意エクスペリエンスが促進されます。 50 を超えるリソース サービス (API) を構成できます。 2021 年 10 月中旬以降は、必要なアクセス許可の合計が 400 を超えることはできません。 null 許容ではありません。

$filter (eq、not、ge、le) をサポートします。
signInAudience String 現在のアプリケーションでサポートされている Microsoft アカウントを指定します。 指定できる値は、 AzureADMyOrg、 AzureADMultipleOrgs、 AzureADandPersonalMicrosoftAccount (既定値)、および PersonalMicrosoftAccountです。 以下の表で詳細を参照してください。

$filter (eq、ne、not) をサポートしています。
SPA spaApplication サイン アウト URL、認証コードとアクセス トークンのリダイレクト URI など、シングルページ アプリケーションの設定を指定します。
tags String collection アプリケーションを分類および識別するために使用できるカスタム文字列です。null 許容型ではありません。

$filter (eq、not、ge、le、startsWith) をサポートしています。
tokenEncryptionKeyId String keyCredentials コレクションにある公開キーの keyId を指定します。 構成されている場合、Azure AD から発行されるすべてのトークンは、このプロパティが指すキーを使用して暗号化されます。 暗号化されたトークンを受け取るアプリケーション コードでは、一致する秘密キーを使用してトークンを複合化してから、サインインしているユーザーのトークンとして使用する必要があります。
verifiedPublisher verifiedPublisher アプリケーションの検証済み発行元を指定します。 発行元の確認がアプリケーションのセキュリティ、信頼性、コンプライアンスをサポートする方法の詳細については、「発行元の確認」 を参照してください。
Web webApplication Web アプリケーションの設定を指定します。

signInAudience 値

値 説明
AzureADMyOrg 組織の Azure AD テナント (シングル テナント) で Microsoft の職場または学校のアカウントを持つユーザー。
AzureADMultipleOrgs いずれかの組織の Azure AD テナント (マルチテナント) で Microsoft の職場または学校のアカウントを持つユーザー。
AzureADandPersonalMicrosoftAccount 個人の Microsoft アカウントを持つユーザー、またはいずれかの組織の Azure AD テナントで職場または学校のアカウントを持つユーザー。 Azure AD B2C ユーザー フローを使用してユーザーを認証する場合は、 AzureADandPersonalMicrosoftAccount を使用します。 この値は、Microsoft、Facebook、Google、Twitter、または OpenID Connect プロバイダーから提供されるローカル アカウントやユーザー ID など、広範囲のユーザーIDで使用できます。 これは、signInAudience プロパティの既定値です。
PersonalMicrosoftAccount 個人の Microsoft アカウントを持つユーザーのみ。

リレーションシップ

リレーションシップ 型 説明
createdOnBehalfOf directoryObject 読み取り専用です。
extensionProperties extensionProperty コレクション 読み取り専用。Null 許容型です。
owners directoryObject コレクション アプリケーションの所有者であるディレクトリ オブジェクトです。読み取り専用です。$expand をサポートします。

JSON 表記

リソースの JSON 表記を次に示します。

{
  "addIns": [{"@odata.type": "microsoft.graph.addIn"}],
  "api": {"@odata.type": "microsoft.graph.apiApplication"},
  "appId": "String",
  "applicationTemplateId": "String",
  "appRoles": [{"@odata.type": "microsoft.graph.appRole"}],
  "createdDateTime": "String (timestamp)",
  "deletedDateTime": "String (timestamp)",
  "disabledByMicrosoftStatus": "String",
  "displayName": "String",
  "groupMembershipClaims": "String",
  "id": "String (identifier)",
  "identifierUris": ["String"],
  "info": {"@odata.type": "microsoft.graph.informationalUrl"},
  "isDeviceOnlyAuthSupported": false,
  "isFallbackPublicClient": false,
  "keyCredentials": [{"@odata.type": "microsoft.graph.keyCredential"}],
  "logo": "Stream",
  "notes": "String",
  "oauth2RequiredPostResponse": false,
  "optionalClaims": {"@odata.type": "microsoft.graph.optionalClaims"},
  "parentalControlSettings": {"@odata.type": "microsoft.graph.parentalControlSettings"},
  "passwordCredentials": [{"@odata.type": "microsoft.graph.passwordCredential"}],
  "publicClient": {"@odata.type": "microsoft.graph.publicClientApplication"},
  "publisherDomain": "String",
  "requiredResourceAccess": [{"@odata.type": "microsoft.graph.requiredResourceAccess"}],
  "signInAudience": "String",
  "spa": {"@odata.type": "microsoft.graph.spaApplication"},
  "tags": ["String"],
  "tokenEncryptionKeyId": "String",
  "verifiedPublisher": {"@odata.type": "microsoft.graph.verifiedPublisher"},
  "web": {"@odata.type": "microsoft.graph.webApplication"}
}