root.composeExtensions.authorization object

Object capturing authorization information for the API-based message extension.

Properties that reference this object type:

• root.composeExtensions.authorization

Syntax

Syntax

{
  "authType": "none | apiSecretServiceAuth | microsoftEntra",
  "microsoftEntraConfiguration": {
    "supportsSingleSignOn": {boolean}
  },
  "apiSecretServiceAuthConfiguration": {
    "apiSecretRegistrationId": "{string}"
  }
}

Schema

{
  "type": "object",
  "description": "Object capturing authorization information.",
  "properties": {
    "authType": {
      "type": "string",
      "enum": [
        "none",
        "apiSecretServiceAuth",
        "microsoftEntra"
      ],
      "description": "Enum of possible authorization types."
    },
    "microsoftEntraConfiguration": {
      "type": "object",
      "description": "Object capturing details needed to do microsoftEntra auth flow. It will be only present when auth type is microsoftEntra.",
      "properties": {
        "supportsSingleSignOn": {
          "type": "boolean",
          "default": false,
          "description": "Boolean indicating whether single sign on is configured for the app."
        }
      },
      "additionalProperties": false
    },
    "apiSecretServiceAuthConfiguration": {
      "type": "object",
      "description": "Object capturing details needed to do service auth. It will be only present when auth type is apiSecretServiceAuth.",
      "properties": {
        "apiSecretRegistrationId": {
          "type": "string",
          "description": "Registration id returned when developer submits the api key through Developer Portal.",
          "maxLength": 128
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

Syntax

{
  "authType": "none | apiSecretServiceAuth | microsoftEntra",
  "microsoftEntraConfiguration": {
    "supportsSingleSignOn": {boolean}
  },
  "apiSecretServiceAuthConfiguration": {
    "apiSecretRegistrationId": "{string}"
  }
}

Schema

{
  "type": "object",
  "description": "Object capturing authorization information.",
  "properties": {
    "authType": {
      "type": "string",
      "enum": [
        "none",
        "apiSecretServiceAuth",
        "microsoftEntra"
      ],
      "description": "Enum of possible authentication types."
    },
    "microsoftEntraConfiguration": {
      "type": "object",
      "description": "Object capturing details needed to do single aad auth flow. It will be only present when auth type is entraId.",
      "properties": {
        "supportsSingleSignOn": {
          "type": "boolean",
          "default": false,
          "description": "Boolean indicating whether single sign on is configured for the app."
        }
      },
      "additionalProperties": false
    },
    "apiSecretServiceAuthConfiguration": {
      "type": "object",
      "description": "Object capturing details needed to do service auth. It will be only present when auth type is apiSecretServiceAuth.",
      "properties": {
        "apiSecretRegistrationId": {
          "type": "string",
          "description": "Registration id returned when developer submits the api key through Developer Portal.",
          "maxLength": 128
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

Properties

authType

Enum of possible authorization types.

Type
string

Required
—

Constraints

Supported values
Allowed values: none, apiSecretServiceAuth, microsoftEntra.

microsoftEntraConfiguration

Object capturing details needed to do microsoftEntra auth flow. Applicable only when auth type is microsoftEntra.

Type
microsoftEntraConfiguration

Required
—

Constraints

Supported values

apiSecretServiceAuthConfiguration

Object capturing details needed to do service auth. Applicable only when auth type is apiSecretServiceAuth.

Type
apiSecretServiceAuthConfiguration

Required
—

Constraints

Supported values