Create or replace claimsPolicy
Namespace: microsoft.graph
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Create a new customClaimsPolicy object if it doesn't exist, or replace an existing one.
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | Policy.Read.ApplicationConfiguration | Policy.ReadWrite.ApplicationConfiguration |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | Policy.Read.ApplicationConfiguration | Policy.ReadWrite.ApplicationConfiguration |
In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. Application Administrator is the least privileged role supported for this operation.
HTTP request
PUT /servicePrincipals/{servicePrincipalsId}/claimsPolicy
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Content-Type | application/json. Required. |
Request body
In the request body, supply a JSON representation of the customClaimsPolicy object.
You can specify the following properties when creating a customClaimsPolicy.
Property | Type | Description |
---|---|---|
includeBasicClaimSet | Boolean | Determines whether the basic claim set is included in tokens affected by this policy. If set to true , all claims in the basic claim set are emitted in tokens affected by the policy. By default the basic claim set isn't in the tokens, unless they're explicitly configured in this policy. Optional. |
includeApplicationIdInIssuer | Boolean | Indicates whether the application ID is added to the claim. It is relevant only for SAML2.0 and if a custom signing key is used. the default value is true . Optional. |
audienceOverride | String | If specified, it overrides the content of the audience claim for WS-Federation and SAML2 protocols. A custom signing key must be used for audienceOverride to be applied, otherwise audienceOverride value is ignored. The value provided must be in the format of an absolute URI. Optional. |
claims | customClaimBase collection | Defines which claims are present in the tokens affected by the policy, in addition to the basic claim and the core claim set. Optional. |
Response
If successful, this method returns a 204
response code and a customClaimsPolicy object in the response body.
Examples
Request
The following example shows a request.
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"
}
]
}
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
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"
}
]
}
피드백
https://aka.ms/ContentUserFeedback
출시 예정: 2024년 내내 콘텐츠에 대한 피드백 메커니즘으로 GitHub 문제를 단계적으로 폐지하고 이를 새로운 피드백 시스템으로 바꿀 예정입니다. 자세한 내용은 다음을 참조하세요.다음에 대한 사용자 의견 제출 및 보기