Auth0 · Schema

SelfServiceProfileSsoTicketConnectionConfig

If provided, this will create a new connection for the Self-Service Enterprise Configuration flow with the given configuration

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM

Properties

Name	Type	Description
name	string	The name of the connection that will be created as a part of the Self-Service Enterprise Configuration flow.
display_name	string	Connection name used in the new universal login experience
is_domain_connection	boolean	`true` promotes to a domain-level connection so that third-party applications can use it. `false` does not promote the connection, so only first-party applications with the conne
show_as_button	boolean	Enables showing a button for the connection in the login page (new experience only). If false, it will be usable only by HRD. (Defaults to `false`.)
metadata	object
options	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SelfServiceProfileSsoTicketConnectionConfig",
  "title": "SelfServiceProfileSsoTicketConnectionConfig",
  "type": "object",
  "description": "If provided, this will create a new connection for the Self-Service Enterprise Configuration flow with the given configuration",
  "additionalProperties": false,
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the connection that will be created as a part of the Self-Service Enterprise Configuration flow.",
      "default": "sso-generated-SAML-customer-12",
      "minLength": 1,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9](-[a-zA-Z0-9]|[a-zA-Z0-9])*$"
    },
    "display_name": {
      "type": "string",
      "description": "Connection name used in the new universal login experience",
      "maxLength": 128
    },
    "is_domain_connection": {
      "type": "boolean",
      "description": "<code>true</code> promotes to a domain-level connection so that third-party applications can use it. <code>false</code> does not promote the connection, so only first-party applications with the connection enabled can use it. (Defaults to <code>false</code>.)"
    },
    "show_as_button": {
      "type": "boolean",
      "description": "Enables showing a button for the connection in the login page (new experience only). If false, it will be usable only by HRD. (Defaults to <code>false</code>.)"
    },
    "metadata": {
      "$ref": "#/components/schemas/ConnectionsMetadata"
    },
    "options": {
      "$ref": "#/components/schemas/SelfServiceProfileSsoTicketConnectionOptions"
    }
  }
}