clerk.create_enterprise_connection
ActiveTool of Vee3
declared in 1.27.1
Create a SAML or OIDC enterprise SSO connection in a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the new enterprise_connection summary. Cost = 10 tokens.
Parameters schema
{
"type": "object",
"title": "create_clerk_enterprise_connectionArguments",
"required": [
"name",
"provider",
"domains"
],
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "Display name for the enterprise connection."
},
"oidc": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Oidc",
"default": null,
"description": "OIDC client configuration when provider uses OAuth."
},
"saml": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Saml",
"default": null,
"description": "SAML IdP configuration when provider uses SAML."
},
"active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Active",
"default": null,
"description": "Whether the connection is active."
},
"domains": {
"type": "array",
"items": {
"type": "string"
},
"title": "Domains",
"description": "Email domains that may use this connection."
},
"provider": {
"type": "string",
"title": "Provider",
"description": "Identity provider key (for example saml_custom or oidc_custom)."
},
"organization_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Organization Id",
"default": null,
"description": "Clerk organization id (org_...) to link to this connection."
},
"clerk_instance_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Clerk Instance Id",
"default": null,
"description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account."
},
"custom_attributes": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
{
"type": "null"
}
],
"title": "Custom Attributes",
"default": null,
"description": "Custom attribute mappings from the IdP to user metadata."
},
"sync_user_attributes": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Sync User Attributes",
"default": null,
"description": "Whether to sync user attributes on each sign-in."
},
"allow_organization_account_linking": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Allow Organization Account Linking",
"default": null,
"description": "Whether account linking via organization membership is allowed."
},
"disable_additional_identifications": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Disable Additional Identifications",
"default": null,
"description": "Whether to block additional identifications for this connection."
}
}
}Parent server
Vee3
https://github.com/Vee3io/Vee3
1/7 registries