SSOConfigResponse

Fields

SSO configuration response (certificate is masked).

26 fields

audience

string or null

created_at · required

string (date-time)

default_role · required

UserRole

display_name · required

string

enforcement_mode · required

SSOEnforcementMode

group_attribute

string or null

id · required

string (uuid)

idp_certificate_fingerprint

string

idp_entity_id

string or null

idp_slo_url

string or null

idp_sso_url

string or null

is_active · required

boolean

last_test_at

string (date-time) or null

last_test_error

string or null

last_test_success

boolean or null

oidc_client_id

string or null

oidc_client_secret_set

boolean

oidc_groups_claim

string or null

oidc_issuer

string or null

oidc_redirect_uri

string or null

oidc_scopes

string or null

provider_type · required

SSOProviderType

role_mapping

object or null

sp_acs_url

string or null

sp_entity_id

string or null

updated_at

string (date-time) or null

Raw schema (JSON)

{
  "description": "SSO configuration response (certificate is masked).",
  "properties": {
    "audience": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Audience"
    },
    "created_at": {
      "format": "date-time",
      "title": "Created At",
      "type": "string"
    },
    "default_role": {
      "$ref": "#/components/schemas/UserRole"
    },
    "display_name": {
      "title": "Display Name",
      "type": "string"
    },
    "enforcement_mode": {
      "$ref": "#/components/schemas/SSOEnforcementMode"
    },
    "group_attribute": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Group Attribute"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "idp_certificate_fingerprint": {
      "default": "",
      "title": "Idp Certificate Fingerprint",
      "type": "string"
    },
    "idp_entity_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Idp Entity Id"
    },
    "idp_slo_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Idp Slo Url"
    },
    "idp_sso_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Idp Sso Url"
    },
    "is_active": {
      "title": "Is Active",
      "type": "boolean"
    },
    "last_test_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Last Test At"
    },
    "last_test_error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Last Test Error"
    },
    "last_test_success": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Last Test Success"
    },
    "oidc_client_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Oidc Client Id"
    },
    "oidc_client_secret_set": {
      "default": false,
      "title": "Oidc Client Secret Set",
      "type": "boolean"
    },
    "oidc_groups_claim": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Oidc Groups Claim"
    },
    "oidc_issuer": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Oidc Issuer"
    },
    "oidc_redirect_uri": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Oidc Redirect Uri"
    },
    "oidc_scopes": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Oidc Scopes"
    },
    "provider_type": {
      "$ref": "#/components/schemas/SSOProviderType"
    },
    "role_mapping": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Role Mapping"
    },
    "sp_acs_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Sp Acs Url"
    },
    "sp_entity_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Sp Entity Id"
    },
    "updated_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Updated At"
    }
  },
  "required": [
    "id",
    "display_name",
    "provider_type",
    "default_role",
    "enforcement_mode",
    "is_active",
    "created_at"
  ],
  "title": "SSOConfigResponse",
  "type": "object"
}

Used by endpoints

4 endpoints send or return this schema, on its own or inside another schema.

• GET /api/v1/sso/configs — List Sso Configs
• POST /api/v1/sso/configs — Create Sso Config
• GET /api/v1/sso/configs/{config_id} — Get Sso Config
• PATCH /api/v1/sso/configs/{config_id} — Update Sso Config

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON