创建或替换 claimsPolicy

项目
10/14/2024

命名空间：microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。不支持在生产应用程序中使用这些 API。若要确定 API 是否在 v1.0 中可用，请使用版本选择器。

创建新的 customClaimsPolicy 对象（如果不存在），或替换现有对象。

全局服务	美国政府 L4	美国政府 L5 (DOD)	由世纪互联运营的中国
✅	❌	❌	❌

权限

为此 API 选择标记为最低特权的权限。只有在应用需要它时，才使用更高的特权权限。有关委派权限和应用程序权限的详细信息，请参阅权限类型。要了解有关这些权限的详细信息，请参阅权限参考。

权限类型	最低特权权限	更高特权权限
委派（工作或学校帐户）	Policy.Read.ApplicationConfiguration	Policy.ReadWrite.ApplicationConfiguration
委派（个人 Microsoft 帐户）	不支持。	不支持。
应用程序	Policy.Read.ApplicationConfiguration	Policy.ReadWrite.ApplicationConfiguration

在具有工作或学校帐户的委托方案中，必须为登录用户分配受支持的Microsoft Entra角色或具有支持的角色权限的自定义角色。 应用程序管理员 是此操作支持的最低特权角色。

HTTP 请求

PUT /servicePrincipals/{servicePrincipalsId}/claimsPolicy

请求标头

名称	说明
Authorization	持有者 {token}。必填。详细了解身份验证和授权。
Content-Type	application/json. 必需。

请求正文

在请求正文中，提供 customClaimsPolicy 对象的 JSON 表示形式。

在创建自定义 ClaimsPolicy 时，可以指定以下属性。

属性	类型	说明
includeBasicClaimSet	布尔值	确定基本声明集是否包含在受此策略影响的令牌中。如果设置为 `true`，则基本声明集中的所有声明都会在受策略影响的令牌中发出。默认情况下，基本声明集不在令牌中，除非已在此策略中显式配置。可选。
includeApplicationIdInIssuer	布尔值	指示是否将应用程序 ID 添加到声明。它仅与 SAML2.0 以及是否使用自定义签名密钥相关。默认值为 `true`。可选。
audienceOverride	String	如果指定，它将替代 WS-Federation 和 SAML2 协议的受众声明的内容。必须使用自定义签名密钥来应用 audienceOverride，否则将忽略 audienceOverride 值。提供的值必须采用绝对 URI 的格式。可选。
索赔	customClaimBase 集合	除了基本声明和核心声明集外，还定义受策略影响的令牌中存在的声明。可选。

响应

如果成功，此方法在 204 响应正文中返回响应代码和 customClaimsPolicy 对象。

示例

请求

以下示例显示了一个请求。

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"
    }
  ]
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new CustomClaimsPolicy
{
	OdataType = "#microsoft.graph.customClaimsPolicy",
	IncludeBasicClaimSet = boolean,
	IncludeApplicationIdInIssuer = boolean,
	AudienceOverride = "String",
	Claims = new List<CustomClaimBase>
	{
		new CustomClaim
		{
			OdataType = "microsoft.graph.customClaim",
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.ServicePrincipals["{servicePrincipal-id}"].ClaimsPolicy.PutAsync(requestBody);

重要

Microsoft Graph SDK 默认使用 v1.0 版本的 API，并且不支持 beta 版本中提供的所有类型、属性和 API。有关使用 SDK 访问 beta API 的详细信息，请参阅将 Microsoft Graph SDK 与 beta API 配合使用。

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。



mgc-beta service-principals claims-policy put --service-principal-id {servicePrincipal-id} --body '{\
  "@odata.type": "#microsoft.graph.customClaimsPolicy",\
  "includeBasicClaimSet": "Boolean",\
  "includeApplicationIdInIssuer": "Boolean",\
  "audienceOverride": "String",\
  "claims": [\
    {\
      "@odata.type": "microsoft.graph.customClaim"\
    }\
  ]\
}\
'

重要

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewCustomClaimsPolicy()
includeBasicClaimSet := boolean
requestBody.SetIncludeBasicClaimSet(&includeBasicClaimSet) 
includeApplicationIdInIssuer := boolean
requestBody.SetIncludeApplicationIdInIssuer(&includeApplicationIdInIssuer) 
audienceOverride := "String"
requestBody.SetAudienceOverride(&audienceOverride) 


customClaimBase := graphmodels.NewCustomClaim()

claims := []graphmodels.CustomClaimBaseable {
	customClaimBase,
}
requestBody.SetClaims(claims)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
claimsPolicy, err := graphClient.ServicePrincipals().ByServicePrincipalId("servicePrincipal-id").ClaimsPolicy().Put(context.Background(), requestBody, nil)

重要

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

CustomClaimsPolicy customClaimsPolicy = new CustomClaimsPolicy();
customClaimsPolicy.setOdataType("#microsoft.graph.customClaimsPolicy");
customClaimsPolicy.setIncludeBasicClaimSet(boolean);
customClaimsPolicy.setIncludeApplicationIdInIssuer(boolean);
customClaimsPolicy.setAudienceOverride("String");
LinkedList<CustomClaimBase> claims = new LinkedList<CustomClaimBase>();
CustomClaim customClaimBase = new CustomClaim();
customClaimBase.setOdataType("microsoft.graph.customClaim");
claims.add(customClaimBase);
customClaimsPolicy.setClaims(claims);
CustomClaimsPolicy result = graphClient.servicePrincipals().byServicePrincipalId("{servicePrincipal-id}").claimsPolicy().put(customClaimsPolicy);

重要

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。


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);

重要

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\CustomClaimsPolicy;
use Microsoft\Graph\Beta\Generated\Models\CustomClaimBase;
use Microsoft\Graph\Beta\Generated\Models\CustomClaim;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new CustomClaimsPolicy();
$requestBody->setOdataType('#microsoft.graph.customClaimsPolicy');
$requestBody->setIncludeBasicClaimSet(boolean);
$requestBody->setIncludeApplicationIdInIssuer(boolean);
$requestBody->setAudienceOverride('String');
$claimsCustomClaimBase1 = new CustomClaim();
$claimsCustomClaimBase1->setOdataType('microsoft.graph.customClaim');
$claimsArray []= $claimsCustomClaimBase1;
$requestBody->setClaims($claimsArray);


$result = $graphServiceClient->servicePrincipals()->byServicePrincipalId('servicePrincipal-id')->claimsPolicy()->put($requestBody)->wait();

重要

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。


Import-Module Microsoft.Graph.Beta.Applications

$params = @{
	"@odata.type" = "#microsoft.graph.customClaimsPolicy"
	includeBasicClaimSet = "Boolean"
	includeApplicationIdInIssuer = "Boolean"
	audienceOverride = "String"
	claims = @(
		@{
			"@odata.type" = "microsoft.graph.customClaim"
		}
	)
}

Set-MgBetaServicePrincipalClaimPolicy -ServicePrincipalId $servicePrincipalId -BodyParameter $params

重要

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.custom_claims_policy import CustomClaimsPolicy
from msgraph_beta.generated.models.custom_claim_base import CustomClaimBase
from msgraph_beta.generated.models.custom_claim import CustomClaim
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = CustomClaimsPolicy(
	odata_type = "#microsoft.graph.customClaimsPolicy",
	include_basic_claim_set = Boolean,
	include_application_id_in_issuer = Boolean,
	audience_override = "String",
	claims = [
		CustomClaim(
			odata_type = "microsoft.graph.customClaim",
		),
	],
)

result = await graph_client.service_principals.by_service_principal_id('servicePrincipal-id').claims_policy.put(request_body)

重要

有关如何将 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"
    }
  ]
}

通过

创建或替换 claimsPolicy

权限

HTTP 请求

请求标头

请求正文

响应

示例

请求

响应

反馈

其他资源