claimsPolicy のCreateまたは置換

[アーティクル]
05/23/2024

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

新しい customClaimsPolicy オブジェクトが存在しない場合はCreateするか、既存のオブジェクトを置き換えます。

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類	最小特権アクセス許可	より高い特権のアクセス許可
委任 (職場または学校のアカウント)	Policy.Read.ApplicationConfiguration	Policy.ReadWrite.ApplicationConfiguration
委任 (個人用 Microsoft アカウント)	サポートされていません。	サポートされていません。
アプリケーション	Policy.Read.ApplicationConfiguration	Policy.ReadWrite.ApplicationConfiguration

管理者が別のユーザーに対して行動している委任されたシナリオの場合、管理者は次のMicrosoft Entraロールの少なくとも 1 つを必要とします。

アプリケーション管理者

HTTP 要求

PUT /servicePrincipals/{servicePrincipalsId}/claimsPolicy

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須です。認証と認可についての詳細をご覧ください。
Content-Type	application/json. 必須です。

要求本文

要求本文で、 customClaimsPolicy オブジェクトの JSON 表現を指定します。

customClaimsPolicy を作成するときに、次のプロパティを指定できます。

プロパティ	種類	説明
includeBasicClaimSet	ブール型	このポリシーの影響を受けるトークンに基本的な要求セットが含まれるかどうかを判断します。に設定すると `true`、基本要求セット内のすべての要求が、ポリシーの影響を受けるトークンで生成されます。既定では、このポリシーで明示的に構成されていない限り、基本的な要求セットはトークンに含まれません。省略可能。
includeApplicationIdInIssuer	ブール型	アプリケーション ID が要求に追加されるかどうかを示します。これは、SAML2.0 とカスタム署名キーが使用されている場合にのみ関連します。既定値はです `true`。省略可能。
audienceOverride	String	指定すると、WS-Federation および SAML2 プロトコルの対象ユーザー要求の内容がオーバーライドされます。 audienceOverride を適用するには、カスタム署名キーを使用する必要があります。それ以外の場合、audienceOverride 値は無視されます。指定する値は、絶対 URI の形式である必要があります。省略可能。
主張	customClaimBase コレクション	基本要求とコア要求セットに加えて、ポリシーの影響を受けるトークンに存在する要求を定義します。省略可能。

応答

成功した場合、このメソッドは 204 応答コードと、応答本文に customClaimsPolicy オブジェクトを返します。

例

要求

次の例は要求を示しています。

HTTP
JavaScript

PUT https://graph.microsoft.com/beta/servicePrincipals/{servicePrincipalsId}/claimsPolicy
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.customClaimsPolicy",
  "includeBasicClaimSet": "Boolean",
  "includeApplicationIdInIssuer": "Boolean",
  "audienceOverride": "String",
  "claims": [
    {
      "@odata.type": "microsoft.graph.customClaim"
    }
  ]
}


const options = {
	authProvider,
};

const client = Client.init(options);

const customClaimsPolicy = {
  '@odata.type': '#microsoft.graph.customClaimsPolicy',
  includeBasicClaimSet: 'Boolean',
  includeApplicationIdInIssuer: 'Boolean',
  audienceOverride: 'String',
  claims: [
    {
      '@odata.type': 'microsoft.graph.customClaim'
    }
  ]
};

await client.api('/servicePrincipals/{servicePrincipalsId}/claimsPolicy')
	.version('beta')
	.put(customClaimsPolicy);

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ版で使用可能なすべての型、プロパティ、API がサポートされているわけではありません。 SDK を使用してベータ API にアクセスする方法の詳細については、「ベータ API で Microsoft Graph SDK を使用する」を参照してください。

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.customClaimsPolicy",
  "id": "f914f36d-167e-3fa7-cfa2-355cc5a36689",
  "includeBasicClaimSet": "Boolean",
  "includeApplicationIdInIssuer": "Boolean",
  "audienceOverride": "String",
  "claims": [
    {
      "@odata.type": "microsoft.graph.customClaim"
    }
  ]
}

次の方法で共有