customClaimsPolicy resource type
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.
Represents a claims policy that allows application admins to customize the claims emitted in tokens affected by this policy. Learn more about this policy in the following articles:
- Customize claims using the custom claims policy (preview)
- Claims customization using a policy to learn the difference between this policy and the claims mapping policy
Inherits from entity.
Methods
| Method | Return type | Description |
|---|---|---|
| Get | customClaimsPolicy | Read the properties and relationships of a custom claims policy object. |
| Create or replace | customClaimsPolicy | Create a new custom claims policy object if it doesn't exist, or replace an existing one. |
| Update | customClaimsPolicy | Update the properties of a custom claims policy object. |
Properties
| Property | Type | Description |
|---|---|---|
| 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, the audienceOverride value is ignored. The value provided must be in the format of an absolute URI. |
| claims | customClaim collection | Defines which claims are present in the tokens affected by the policy, in addition to the basic claim and the core claim set. Inherited from customclaimbase. |
| id | String | Policy identifier string. Inherited from entity. |
| 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. |
| 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. |
Relationships
None.
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.customClaimsPolicy",
"id": "String (identifier)",
"includeBasicClaimSet": "Boolean",
"includeApplicationIdInIssuer": "Boolean",
"audienceOverride": "String",
"groupFilter": {
"@odata.type": "microsoft.graph.groupClaimFilterBase"
},
"claims": [
{
"@odata.type": "microsoft.graph.customClaim"
}
]
}