Skip to content

EntraSettings

All wire models

Model aliases: EntraSettings.

Type: object.

Fields

Required means the key must be present. Nullable means its value may be null; it does not make a required key optional. “Not specified” means the schema declares no default.

Field Type Required Default
kind string Yes Not specified
tenant_id string Yes Not specified
client_id string Yes Not specified
directory_client_id string or null No null
membership_mode string No "direct"
identity_mode string No "brokered"

Model constraints

  • Additional properties: not permitted

Field constraints

kind

  • Exact value: "entra"

tenant_id

  • Format: "uuid"

client_id

  • Minimum length: 1
  • Maximum length: 255

directory_client_id

  • anyOf branch 1 (string): Minimum length: 1
  • anyOf branch 1 (string): Maximum length: 255

membership_mode

  • Allowed values: "direct", "transitive"

identity_mode

  • Allowed values: "brokered", "direct"

Exact JSON Schema

This is a schema definition, not an example request. It preserves all declared keywords, including constraints not summarized above.

Complete JSON Schema
JSON
{
  "additionalProperties": false,
  "properties": {
    "kind": {
      "const": "entra",
      "title": "Kind",
      "type": "string"
    },
    "tenant_id": {
      "format": "uuid",
      "title": "Tenant Id",
      "type": "string"
    },
    "client_id": {
      "maxLength": 255,
      "minLength": 1,
      "title": "Client Id",
      "type": "string"
    },
    "directory_client_id": {
      "anyOf": [
        {
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Directory Client Id"
    },
    "membership_mode": {
      "default": "direct",
      "enum": [
        "direct",
        "transitive"
      ],
      "title": "Membership Mode",
      "type": "string"
    },
    "identity_mode": {
      "default": "brokered",
      "enum": [
        "brokered",
        "direct"
      ],
      "title": "Identity Mode",
      "type": "string"
    }
  },
  "required": [
    "kind",
    "tenant_id",
    "client_id"
  ],
  "title": "EntraSettings",
  "type": "object"
}