| Field | Type | Required | Description |
|---|---|---|---|
name |
String | ✔️ | The display name of the connection |
provider |
Provider | ✔️ | The identity provider (e.g. saml_custom, oidc_custom, oidc_github_enterprise, oidc_gitlab) |
domains |
List<String> | ✔️ | Domains associated with the enterprise connection (required; at least one). Values are normalized to lowercase. Each domain must be a valid fully qualified domain name. |
organizationId |
JsonNullable<String> | ➖ | Organization ID when the connection is linked to an organization |
allowOrganizationAccountLinking |
JsonNullable<Boolean> | ➖ | Whether this connection supports account linking via organization membership |
active |
JsonNullable<Boolean> | ➖ | Whether the enterprise connection is active. When true, IdP metadata must be provided via the saml object. |
saml |
JsonNullable<Saml> | ➖ | SAML connection-specific properties. Only applied when the enterprise connection uses SAML (e.g. provider is saml_custom). Use this to set IdP configuration, attribute mapping, and other SAML-specific settings at creation time. |
oidc |
JsonNullable<Oidc> | ➖ | OIDC connection-specific properties. Only applied when the enterprise connection uses OIDC (e.g. provider is oidc_custom, oidc_github_enterprise, or oidc_gitlab). |
customAttributes |
List<CustomAttributes> | ➖ | Custom attributes to map from the IdP to the user's profile via SSO or SCIM provisioning. Requires the custom attributes feature to be enabled for the instance. |