Skip to content

customclaim.md

Latest commit

 

History

History
55 lines (47 loc) · 1.95 KB

customclaim.md

File metadata and controls

55 lines (47 loc) · 1.95 KB
title customClaim resource type
description Represents an individual claim included in the tokens affected by this policy.
author rahul-nagraj
ms.localizationpriority medium
ms.subservice entra-id
doc_type resourcePageType
ms.date 06/10/2024

customClaim resource type

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Represents an individual claim included in the tokens affected by this policy. It consists of a configurable name, namespace, token format, and claim name format. The claim name format is applicable only for SAML tokens.

Inherits from customClaimBase.

Properties

Property Type Description
configurations customClaimConfiguration collection One or more configurations that describe how the claim is sourced and under what conditions. Inherited from customClaimBase.
name String The name of the claim to be emitted.
namespace String An optional namespace to be included as part of the claim name.
samlAttributeNameFormat samlAttributeNameFormat If specified, it sets the nameFormat attribute associated with the claim in the SAML response. The possible values are: unspecified, uri, basic, unknownFutureValue.
tokenFormat tokenFormat collection List of token formats for which this claim should be emitted. The possible values are: saml,jwt, unknownFutureValue

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.customClaim",
  "configurations": [
    {
      "@odata.type": "microsoft.graph.customClaimConfiguration"
    }
  ],
  "name": "String",
  "namespace": "String",
  "tokenFormat": [
    "String"
  ],
  "samlAttributeNameFormat": "String"
}