Microsoft Graph · Schema

optionalClaim

Azure ADCollaborationContactsDocumentsEmailGraphIdentityMicrosoftOffice 365PresentationsProductivitySpreadsheetsT1Tasks

Properties

Name Type Description
additionalProperties array Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property.
essential boolean If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false.
name string The name of the optional claim.
source string The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the
@odata.type string
View JSON Schema on GitHub

JSON Schema

microsoft-graph-microsoftgraphoptionalclaim-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/microsoft.graph.optionalClaim",
  "title": "optionalClaim",
  "required": [
    "@odata.type"
  ],
  "type": "object",
  "properties": {
    "additionalProperties": {
      "type": "array",
      "items": {
        "type": "string",
        "nullable": true
      },
      "description": "Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property."
    },
    "essential": {
      "type": "boolean",
      "description": "If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false."
    },
    "name": {
      "type": "string",
      "description": "The name of the optional claim."
    },
    "source": {
      "type": "string",
      "description": "The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object.",
      "nullable": true
    },
    "@odata.type": {
      "type": "string"
    }
  }
}