SSOConfigCreate

Fields

Create a new SSO configuration.

18 fields

audience

string or null

default_role

UserRole

display_name · required

string

enforcement_mode

SSOEnforcementMode

group_attribute

string or null

idp_certificate

string or null

idp_entity_id

string or null

idp_slo_url

string or null

idp_sso_url

string or null

oidc_client_id

string or null

oidc_client_secret

string or null

oidc_groups_claim

string or null

oidc_issuer

string or null

oidc_scopes

string or null

provider_type

SSOProviderType

role_mapping

object or null

sp_acs_url

string or null

sp_entity_id

string or null

Raw schema (JSON)

{
  "description": "Create a new SSO configuration.\n\nW20 ADM-08b: a SAML config needs the IdP entity id / SSO URL / certificate and\nthe SP entity id / ACS URL; an OIDC config needs the issuer, client id and client\nsecret (write-only — stored in ``secret_refs``, never returned).",
  "properties": {
    "audience": {
      "anyOf": [
        {
          "maxLength": 1000,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Audience"
    },
    "default_role": {
      "$ref": "#/components/schemas/UserRole",
      "default": "VIEWER"
    },
    "display_name": {
      "maxLength": 255,
      "minLength": 2,
      "title": "Display Name",
      "type": "string"
    },
    "enforcement_mode": {
      "$ref": "#/components/schemas/SSOEnforcementMode",
      "default": "OPTIONAL"
    },
    "group_attribute": {
      "anyOf": [
        {
          "maxLength": 255,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Group Attribute"
    },
    "idp_certificate": {
      "anyOf": [
        {
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Idp Certificate"
    },
    "idp_entity_id": {
      "anyOf": [
        {
          "maxLength": 1000,
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Idp Entity Id"
    },
    "idp_slo_url": {
      "anyOf": [
        {
          "maxLength": 2000,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Idp Slo Url"
    },
    "idp_sso_url": {
      "anyOf": [
        {
          "maxLength": 2000,
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Idp Sso Url"
    },
    "oidc_client_id": {
      "anyOf": [
        {
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Oidc Client Id"
    },
    "oidc_client_secret": {
      "anyOf": [
        {
          "maxLength": 4000,
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Oidc Client Secret"
    },
    "oidc_groups_claim": {
      "anyOf": [
        {
          "maxLength": 255,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Oidc Groups Claim"
    },
    "oidc_issuer": {
      "anyOf": [
        {
          "maxLength": 1000,
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Oidc Issuer"
    },
    "oidc_scopes": {
      "anyOf": [
        {
          "maxLength": 500,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Oidc Scopes"
    },
    "provider_type": {
      "$ref": "#/components/schemas/SSOProviderType",
      "default": "SAML"
    },
    "role_mapping": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Role Mapping"
    },
    "sp_acs_url": {
      "anyOf": [
        {
          "maxLength": 2000,
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Sp Acs Url"
    },
    "sp_entity_id": {
      "anyOf": [
        {
          "maxLength": 1000,
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Sp Entity Id"
    }
  },
  "required": [
    "display_name"
  ],
  "title": "SSOConfigCreate",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

• POST /api/v1/sso/configs — Create Sso Config

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON