Skip to content

IdentityProviderPatch

All wire models

Model aliases: IdentityProviderPatch.

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
expected_revision integer Yes Not specified
name string or null No null
settings KeycloakSettings or EntraSettings or GoogleWorkspaceSettings or null No null
credential KeycloakCredential or EntraCredential or GoogleCredential or null No null
credential_reference string or null No null

Model constraints

  • Additional properties: not permitted

Field constraints

expected_revision

  • Minimum: 1

name

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

settings

credential

credential_reference

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

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": {
    "expected_revision": {
      "minimum": 1,
      "title": "Expected Revision",
      "type": "integer"
    },
    "name": {
      "anyOf": [
        {
          "maxLength": 120,
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Name"
    },
    "settings": {
      "anyOf": [
        {
          "discriminator": {
            "mapping": {
              "entra": "#/$defs/EntraSettings",
              "google_workspace": "#/$defs/GoogleWorkspaceSettings",
              "keycloak": "#/$defs/KeycloakSettings"
            },
            "propertyName": "kind"
          },
          "oneOf": [
            {
              "$ref": "#/$defs/KeycloakSettings"
            },
            {
              "$ref": "#/$defs/EntraSettings"
            },
            {
              "$ref": "#/$defs/GoogleWorkspaceSettings"
            }
          ]
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Settings"
    },
    "credential": {
      "anyOf": [
        {
          "discriminator": {
            "mapping": {
              "entra": "#/$defs/EntraCredential",
              "google_workspace": "#/$defs/GoogleCredential",
              "keycloak": "#/$defs/KeycloakCredential"
            },
            "propertyName": "kind"
          },
          "oneOf": [
            {
              "$ref": "#/$defs/KeycloakCredential"
            },
            {
              "$ref": "#/$defs/EntraCredential"
            },
            {
              "$ref": "#/$defs/GoogleCredential"
            }
          ]
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Credential"
    },
    "credential_reference": {
      "anyOf": [
        {
          "maxLength": 120,
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Credential Reference"
    }
  },
  "required": [
    "expected_revision"
  ],
  "title": "IdentityProviderPatch",
  "type": "object"
}