claimsMappingPolicy resource type

Article
12/05/2024

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 the claim-mapping policies for WS-Fed, SAML, OAuth 2.0, and OpenID Connect protocols, for tokens issued to a specific application. You can use claims-mapping policies to:

Select which claims are included in tokens
Create claim types that don't already exist
Choose or change the source of data emitted in specific claims

The number of claims and transformations that can be added to a claims-mapping policy are limited to reduce token size. Any claims schema entries or transformations that are encountered after the limit has been reached are ignored and not included in the issued token. For more information about the limits, see Properties of a claims-mapping policy definition

For more scenario and configuration details, see Claims mapping policy type and How to: Customize claims emitted in tokens for a specific app in a tenant.

Additionally, visit Claims customization using a policy to learn the difference between this policy and the custom claims policy.

Inherits from stsPolicy.

Methods

Method	Return Type	Description
List	claimsMappingPolicy	Read properties and relationships of claimsMappingPolicies objects.
Create	claimsMappingPolicy	Create a claimsMappingPolicy object.
Get	claimsMappingPolicy	Read properties and relationships of a claimsMappingPolicy object.
Update	None	Update a claimsMappingPolicy object.
Delete	None	Delete a claimsMappingPolicy object.
List applies to	directoryObject collection	Get the list of directoryObjects that this policy has been applied to.
Assign to service principal	None	Assign a claimsMappingPolicy to a servicePrincipal object.
List assigned to service principal	claimsMappingPolicy collection	List the claimsMappingPolicy objects that are assigned to a servicePrincipal object.
Unassign from service principal	None	Remove a claimsMappingPolicy from a servicePrincipal object.

Properties

Property	Type	Description
id	String	Unique identifier for this policy. Read-only.
definition	String collection	A string collection containing a JSON string that defines the rules and settings for this policy. For more information about the JSON schema for this property, see Properties of a claims-mapping policy definition. Required.
displayName	String	Display name for this policy. Required.
isOrganizationDefault	Boolean	Ignore this property. The claims-mapping policy can only be applied to service principals and can't be set globally for the organization.

Properties of a claims-mapping policy definition

The JSON object to be inserted into the definition property must first be converted to a string with quotations escaped. This section shows a few definition examples.

Example: definition to include the EmployeeID and TenantCountry as claims in tokens

{
    "definition": [
        "{\"ClaimsMappingPolicy\":{\"Version\":1,\"IncludeBasicClaimSet\":\"true\",\"ClaimsSchema\": [{\"Source\":\"user\",\"ID\":\"employeeid\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name\",\"JwtClaimType\":\"name\"},{\"Source\":\"company\",\"ID\":\"tenantcountry\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/country\",\"JwtClaimType\":\"country\"}]}}"
    ],
    "displayName": "Test1234"
}

Example: definition that uses a claims transformation

{
    "definition": [
        "{\"ClaimsMappingPolicy\":{\"Version\":1,\"IncludeBasicClaimSet\":\"true\",\"ClaimsSchema\": [{\"Source\":\"user\",\"ID\":\"userprincipalname\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier\"},{\"Source\":\"user\",\"ID\":\"givenname\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname\"},{\"Source\":\"user\",\"ID\":\"displayname\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name\"},{\"Source\":\"user\",\"ID\":\"surname\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname\"},{\"Source\":\"user\",\"ID\":\"userprincipalname\",\"SamlClaimType\":\"username\"}],\"ClaimsTransformation\":[{\"ID\":\"CreateTermsOfService\",\"TransformationMethod\":\"CreateStringClaim\",\"InputParameters\": [{\"ID\":\"value\",\"DataType\":\"string\", \"Value\":\"sandbox\"}],\"OutputClaims\":[{\"ClaimTypeReferenceId\":\"TOS\",\"TransformationClaimType\":\"createdClaim\"}]}]}}"
    ],
    "displayName": "Test1234"
}

Property	Type	Description
Version	Integer	Set value of 1. Required.
IncludeBasicClaimSet	Boolean	If set to `true`, all claims in the basic claim set are emitted in tokens affected by the policy. If set to `false`, claims in the basic claim set aren't in the tokens, unless they're individually added in the ClaimsSchema property of the same policy.
ClaimsSchema	JSON object	Defines which claims are present in the tokens affected by the policy, in addition to the basic claim set and the core claim set. For each claim schema entry defined in this property, certain information is required. Specify where the data is coming from (Value or Source/ID pair), and which claim the data is emitted as (Claim Type). A maximum of 50 claims are included in the token through the ClaimsSchema object. Any claims schema entries that are encountered after the limit has been reached are ignored and don't appear in the issued token. Further details are available in the ClaimsSchema definition.
ClaimsTransformation	JSON object	Defines common transformations that can be applied to source data, to generate the output data for claims specified in the ClaimsSchema. A maximum of 50 transformations are included in the token through the ClaimsTransformation object. Any transformations that are encountered after the limit has been reached are ignored and don't appear in the issued token. For more information about ClaimsTransformation and the supported functions, see Claims transformation.

Relationships

Relationship	Type	Description
appliesTo	directoryObject collection	The directoryObject collection that this policy has been applied to. Read-only.

JSON representation

The following JSON representation shows the resource type.

{
  "definition": ["String"],
  "displayName": "String",
  "id": "String (identifier)",
  "isOrganizationDefault": false,
}

Share via