ApiApplication

Settings for an application that implements a web API

Access ManagementAuthenticationAzure ADEntraIdentityIdentity GovernanceMicrosoftNetwork SecuritySecurityZero Trust

Properties

Name	Type	Description
acceptMappedClaims	booleannull	Allows an application to use claims mapping without specifying a custom signing key
knownClientApplications	array	Used for bundling consent. Lists client app IDs that are considered known clients of this API
oauth2PermissionScopes	array	OAuth 2.0 permission scopes exposed by the web API to client applications
preAuthorizedApplications	array	Lists client applications pre-authorized with specified delegated permissions that do not require user consent
requestedAccessTokenVersion	integernull	Specifies the access token version expected by the resource. Possible values are 1 or 2.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ApiApplication",
  "title": "ApiApplication",
  "type": "object",
  "description": "Settings for an application that implements a web API",
  "properties": {
    "acceptMappedClaims": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Allows an application to use claims mapping without specifying a custom signing key",
      "example": "example_value"
    },
    "knownClientApplications": {
      "type": "array",
      "description": "Used for bundling consent. Lists client app IDs that are considered known clients of this API",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "example": []
    },
    "oauth2PermissionScopes": {
      "type": "array",
      "description": "OAuth 2.0 permission scopes exposed by the web API to client applications",
      "items": {
        "$ref": "#/components/schemas/PermissionScope"
      },
      "example": []
    },
    "preAuthorizedApplications": {
      "type": "array",
      "description": "Lists client applications pre-authorized with specified delegated permissions that do not require user consent",
      "items": {
        "type": "object",
        "properties": {
          "appId": {
            "type": "string"
          },
          "delegatedPermissionIds": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "uuid"
            }
          }
        }
      },
      "example": []
    },
    "requestedAccessTokenVersion": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Specifies the access token version expected by the resource. Possible values are 1 or 2.",
      "enum": [
        1,
        2,
        null
      ],
      "example": 1
    }
  }
}