Organization Federation Settings

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mongodb/main/json-schema/mongodb-org-federation-settings-schema.json",
  "title": "Organization Federation Settings",
  "description": "Details that define how to connect one MongoDB Cloud organization to one federated authentication service.",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/mongodb-federated-authentication-api-openapi.yml#/components/schemas/OrgFederationSettings",
  "properties": {
    "federatedDomains": {
      "description": "List of domains associated with the organization's identity provider.",
      "items": {
        "type": "string"
      },
      "type": "array",
      "uniqueItems": true
    },
    "hasRoleMappings": {
      "description": "Flag that indicates whether this organization has role mappings configured.",
      "type": "boolean"
    },
    "id": {
      "description": "Unique 24-hexadecimal digit string that identifies this federation.",
      "pattern": "^([a-f0-9]{24})$",
      "readOnly": true,
      "type": "string"
    },
    "identityProviderId": {
      "description": "Legacy 20-hexadecimal digit string that identifies the identity provider connected to this organization.",
      "pattern": "^([a-f0-9]{20})$",
      "type": "string"
    },
    "identityProviderStatus": {
      "description": "String enum that indicates whether the identity provider is active.",
      "enum": [
        "ACTIVE",
        "INACTIVE"
      ],
      "type": "string"
    }
  },
  "required": [
    "federatedDomains"
  ],
  "type": "object"
}