名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
アプリケーション オブジェクトのプロパティを更新します。 この API は、@odata.type プロパティが #microsoft.graph.agentIdentityBlueprint に設定されている場合に agentIdentityBlueprint オブジェクトを更新することもできます。
重要
PATCH を使用して passwordCredential を設定することはサポートされていません。 アプリケーションのパスワードまたはシークレットを更新するには、 addPassword メソッドと removePassword メソッドを使用します。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
|---|---|---|---|
| ✅ | ✅ | ✅ | ✅ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
|---|---|---|
| 委任 (職場または学校のアカウント) | Application.ReadWrite.All | AgentIdentityBlueprint.AddRemoveCreds.All、AgentIdentityBlueprint.ReadWrite.All、AgentIdentityBlueprint.UpdateAuthProperties.All、AgentIdentityBlueprint.UpdateBranding.All、AgentIdentityBlueprintPrincipal.ReadWrite.All |
| 委任 (個人用 Microsoft アカウント) | Application.ReadWrite.All | 注意事項なし。 |
| アプリケーション | Application.ReadWrite.OwnedBy | AgentIdentityBlueprint.AddRemoveCreds.All、AgentIdentityBlueprint.ReadWrite.All、AgentIdentityBlueprint.UpdateAuthProperties.All、AgentIdentityBlueprint.UpdateBranding.All、AgentIdentityBlueprintPrincipal.ReadWrite.All、Application.ReadWrite.All |
重要
職場または学校アカウントを使用する委任されたシナリオでは、管理者にサポートされているMicrosoft Entraロールまたはサポートされているロールのアクセス許可を持つカスタム ロールを割り当てる必要があります。 この操作では、次の最小特権ロールがサポートされています。
- テナント管理者がアクセスを制限していない限り、既定のユーザーアクセス許可を持つ管理者以外のメンバーまたはゲスト
- アプリケーション開発者 - 管理者がメンバーとゲストへのアクセスを制限している場合でもアプリを作成します。このロールを持つプリンシパルには、作成するアプリの所有権が割り当てられます
- ディレクトリ ライター - 拡張機能のプロパティを更新する
- ハイブリッド ID 管理者 - 基本プロパティのみを更新する
- セキュリティ管理者
- クラウド アプリケーション管理者
- アプリケーション管理者
HTTP 要求
アプリケーションのアドレスは、 その ID または appId を使用して行うことができます。
id と appId は、Microsoft Entra 管理センターのアプリ登録でそれぞれオブジェクト ID とアプリケーション (クライアント) ID と呼ばれます。
{applicationObjectId}をアプリケーション オブジェクトの ID に置き換えます。
PATCH /applications/{applicationObjectId}
PATCH /applications(appId='{appId}')
ロゴを更新するには、次のように PUT メソッドを使用します。
PUT /applications/{applicationObjectId}/logo
PUT /applications(appId='{appId}')/logo
要求ヘッダー
| 名前 | 説明 |
|---|---|
| Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
| Content-Type | application/json. 必須です。 |
要求本文
要求本文で、更新する関連フィールドの値を指定します。 要求本文に含まれていない既存のプロパティは、以前の値を維持するか、他のプロパティ値の変更に基づいて再計算されます。 最適なパフォーマンスを得るには、変更されていない値を含めないでください。
| プロパティ | 型 | 説明 |
|---|---|---|
| api | apiApplication | Web API を実装するアプリケーションの設定を指定します。 |
| appRoles | appRole コレクション | アプリケーションに対して定義されているロールのコレクション。 これらのロールは、ユーザー、グループ、サービス プリンシパルなどに割り当てることができます。 null 許容型ではありません。 |
| displayName | String | アプリケーションの表示名。 |
| groupMembershipClaims | 文字列 | アプリケーションが予期するユーザーまたは OAuth 2.0 アクセス トークンで発行された グループ 要求を構成します。 この属性を設定するには、次のいずれかの有効な文字列値を使用します。
|
| identifierUris | String collection | Microsoft Entra テナント内のアプリケーションを識別する URI、またはアプリケーションがマルチテナントの場合は検証済みのカスタム ドメイン内の URI。 詳細については、「Application オブジェクトとサービス プリンシパル オブジェクト」を参照してください。 null 許容ではありません。 |
| info | informationalUrl | アプリのマーケティング、サポート、サービス条件、プライバシーに関する声明の URL など、アプリケーションの基本的なプロファイル情報。 サービス利用規約とプライバシーに関する声明は、ユーザーの同意エクスペリエンスからユーザーに提示されます。 詳細については、「登録済みのMicrosoft Entra アプリのサービス条件とプライバシーに関する声明を追加する」を参照してください。 |
| isDisabled | ブール型 | テナント内またはマルチテナント アプリのテナント間のアプリのサービス プリンシパルが、新しいアクセス トークンを取得できるか、保護されたリソースにアクセスできるかを指定します。
trueに設定すると、既存のトークンは、構成された有効期間に基づいて有効期限が切れるまで有効なままであり、アプリは Enterprise アプリの一覧に表示されたままですが、アプリケーションが非アクティブ化 (無効) の場合、ユーザーは trueサインインできません(無効)、それ以外の場合はfalse。 |
| isFallbackPublicClient | Boolean | モバイル デバイスで実行するインストール済みアプリケーションなど、フォールバック アプリケーションの種類をパブリック クライアントとして指定します。 既定値は falseです。つまり、フォールバック アプリケーションの種類は Web アプリなどの機密クライアントです。 Microsoft Entra IDがクライアント アプリケーションの種類 (たとえば、リダイレクト URI を指定せずに構成されている ROPC フロー) を特定できないシナリオがあります。 このような場合、Microsoft Entra IDは、このプロパティの値に基づいてアプリケーションの種類を解釈します。 |
| keyCredentials | keyCredential コレクション | アプリケーションに関連付けられているキー資格情報のコレクションです。 null 許容型ではありません。 |
| logo | Stream | アプリケーションのメイン ロゴです。 null 許容ではありません。 PUT メソッドを使用してロゴを更新します。 |
| nativeAuthenticationApisEnabled | 文字列 | ネイティブ認証 API をアプリケーションが使用してネイティブ認証を提供できるように、ネイティブ認証 API を有効にするかどうかを指定します。 使用可能な値は none、all、および unknownFutureValue です。 詳細については、「 ネイティブ認証」を参照してください。 |
| onPremisesPublishing | onPremisesPublishing | オンプレミス アプリケーションのアプリケーション プロキシMicrosoft Entra構成するためのプロパティのセットを表します。 このプロパティは、アプリケーションが作成された後にのみ設定でき、他のアプリケーション プロパティと同じ要求で更新することはできません。 |
| optionalClaims | optionalClaims | アプリケーション開発者は、Microsoft Entra アプリでオプションの要求を構成して、Microsoft セキュリティ トークン サービスによってアプリケーションに送信されるトークンで必要な要求を指定できます。 詳細については、「 省略可能な要求」を参照してください。 |
| parentalControlSettings | parentalControlSettings | アプリケーションにおける、保護者による制限設定を指定します。 |
| publicClient | publicClientApplication | デスクトップやモバイル デバイスなど、インストールされているクライアントの設定を指定します。 |
| requiredResourceAccess | requiredResourceAccess コレクション | アプリケーションがアクセスする必要があるリソースを指定します。 このプロパティでは、各リソースに必要な委任されたアクセス許可とアプリケーション ロールのセットも指定します。 必要なリソースへのアクセスに対するこの構成によって、同意エクスペリエンスが促進されます。 50 を超えるリソース サービス (API) を構成できます。 2021 年 10 月中旬以降は、必要なアクセス許可の合計が 400 を超えることはできません。 null 許容ではありません。 |
| samlMetadataUrl | String | サービスによりフェデレーション用の SAML メタデータが公開されている URL。 このプロパティは、シングルテナント アプリケーションに対してのみ有効です。 |
| signInAudience | 文字列 | アプリケーションでサポートされているアカウントの種類を指定します。 サポートされている値は次のとおりです。
このプロパティの値は、他のアプリ オブジェクト プロパティに影響します。 その結果、このプロパティを変更する場合は、最初に他のプロパティを変更する必要があります。 詳細については、「 signInAudience の検証の違い」を参照してください。 |
| signInAudienceRestrictions | signInAudienceRestrictionsBase |
signInAudience で指定されているサポートされているアカウントの種類に対する制限を指定します。 値の型によって、適用できる制限が決まります。
|
| SPA | spaApplication | サイン アウト URL、認証コードとアクセス トークンのリダイレクト URI など、シングルページ アプリケーションの設定を指定します。 |
| tags | String コレクション | アプリケーションを分類および識別するために使用できるカスタム文字列です。 null 許容ではありません。 |
| tokenEncryptionKeyId | 文字列 | keyCredentials コレクションにある公開キーの keyId を指定します。 構成すると、Microsoft Entra IDは、このプロパティが指すキーを使用して、出力されるすべてのトークンを暗号化します。 暗号化されたトークンを受け取るアプリケーション コードでは、一致する秘密キーを使用してトークンを複合化してから、サインインしているユーザーのトークンとして使用する必要があります。 |
| uniqueName | String | アプリケーションに割り当て、代替キーとして使用できる一意の識別子。
nullが設定されると変更できない場合にのみ更新できます。 |
| Web | webApplication | Web アプリケーションの設定を指定します。 |
| SPA | spaApplication | サイン アウト URL、認証コードとアクセス トークンのリダイレクト URI など、シングルページ アプリケーションの設定を指定します。 |
| windows | windowsApplication | Microsoft Windows を実行し、Microsoft Store または Xbox ゲーム ストアで公開されているアプリの設定を指定します。 承認コードとアクセス トークンのパッケージ SID とリダイレクト URI が含まれています。 |
応答
成功した場合、このメソッドは 204 No Content 応答コードを返し、応答本文では何も返しません。
例
例 1: アプリケーションの displayName を更新する
要求
次の要求は、例を示しています。
PATCH https://graph.microsoft.com/beta/applications/{id}
Content-type: application/json
{
"displayName": "New display name"
}
応答
HTTP/1.1 204 No Content
例 2: アプリケーションの appRoles を更新する
次の例では、アプリケーションの appRoles コレクションを更新します。 既存のアプリ ロールを保持するには、それらを要求に含めます。 要求に含まれていないコレクション内の既存のオブジェクトは、新しいオブジェクトに置き換えられます。 このオブジェクトは、テナント内のサービス プリンシパルの対応するプロパティと同期されます。
要求
PATCH https://graph.microsoft.com/beta/applications/fda284b5-f0ad-4763-8289-31a273fca865
Content-type: application/json
{
"appRoles": [
{
"allowedMemberTypes": [
"User",
"Application"
],
"description": "Survey.Read",
"displayName": "Survey.Read",
"id": "ebb7c86c-fb47-4e3f-8191-420ff1b9de4a",
"isEnabled": false,
"origin": "Application",
"value": "Survey.Read"
}
]
}
応答
HTTP/1.1 204 No Content
例 3: シングルテナント アプリケーションを制限付きマルチテナントに変換する
要求
次の要求は、アプリケーションの signInAudience をシングルテナント (AzureADMyOrg) からマルチテナント (AzureADMultipleOrgs) に更新し、同時に signInAudienceRestrictions を設定して、アプリを 2 つの許可されたテナント (およびアプリが登録されているテナント) でのみ使用できるようにする例を示しています。
PATCH https://graph.microsoft.com/beta/applications/{id}
Content-type: application/json
{
"signInAudience": "AzureADMultipleOrgs",
"signInAudienceRestrictions": {
"@odata.type": "#microsoft.graph.allowedTenantsAudience",
"isHomeTenantAllowed": true,
"allowedTenantIds": [
"818ce016-78c2-457c-91d7-c02c2faaa5fe",
"c62670b0-53a1-4a38-b26c-4093cbaa510a"
]
}
}
応答
HTTP/1.1 204 No Content
例 4: 制限付きマルチテナント アプリケーションをシングル テナントに変換する
要求
次の要求は、アプリケーションの signInAudience をシングルテナント (AzureADMyOrg) に更新し、同時に signInAudienceRestrictions を削除する例を示しています。 これは、アプリケーションがマルチテナントであり、制限されていない期間(organizationのポリシーで必要になる可能性がある)を回避するために、同時にこれを行うことをお勧めします。
PATCH https://graph.microsoft.com/beta/applications/{id}
Content-type: application/json
{
"signInAudience": "AzureADMyOrg",
"signInAudienceRestrictions": {
"@odata.type": "#microsoft.graph.unrestrictedAudience"
}
}
応答
HTTP/1.1 204 No Content