Auth0 · Schema

GetConnectionResponseContent

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM

Properties

Name	Type	Description
name	string	The name of the connection
display_name	string	Connection name used in login screen
options	object
id	string	The connection's identifier
strategy	string	The type of the connection, related to the identity provider
realms	array	Defines the realms for which the connection will be used (ie: email domains). If the array is empty or the property is not specified, the connection name will be added as realm.
enabled_clients	array	DEPRECATED property. Use the GET /connections/:id/clients endpoint to get the ids of the clients for which the connection is enabled
is_domain_connection	boolean	True if the connection is domain level
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.
metadata	object
authentication	object
connected_accounts	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetConnectionResponseContent",
  "title": "GetConnectionResponseContent",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the connection",
      "default": "My connection"
    },
    "display_name": {
      "type": "string",
      "description": "Connection name used in login screen"
    },
    "options": {
      "$ref": "#/components/schemas/ConnectionOptions"
    },
    "id": {
      "type": "string",
      "description": "The connection's identifier",
      "default": "con_0000000000000001"
    },
    "strategy": {
      "type": "string",
      "description": "The type of the connection, related to the identity provider",
      "default": "auth0"
    },
    "realms": {
      "type": "array",
      "description": "Defines the realms for which the connection will be used (ie: email domains). If the array is empty or the property is not specified, the connection name will be added as realm.",
      "items": {
        "type": "string",
        "description": "The realm where this connection belongs",
        "format": "connection-realm"
      }
    },
    "enabled_clients": {
      "type": "array",
      "description": "DEPRECATED property. Use the GET /connections/:id/clients endpoint to get the ids of the clients for which the connection is enabled",
      "x-release-lifecycle": "deprecated",
      "items": {
        "type": "string",
        "description": "The client id"
      }
    },
    "is_domain_connection": {
      "type": "boolean",
      "description": "True if the connection is domain level"
    },
    "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."
    },
    "metadata": {
      "$ref": "#/components/schemas/ConnectionsMetadata"
    },
    "authentication": {
      "$ref": "#/components/schemas/ConnectionAuthenticationPurpose",
      "x-release-lifecycle": "GA"
    },
    "connected_accounts": {
      "$ref": "#/components/schemas/ConnectionConnectedAccountsPurpose",
      "x-release-lifecycle": "GA"
    }
  }
}