āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā ā š shadcn/directory/clerk/clerk-docs/reference/backend/saml-connections/update-saml-connection ā āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā
āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā
ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā
updateSamlConnection()'
description: Use Clerk's JS Backend SDK to update a SAML connection.
sdk: js-backendUpdates a SamlConnection by its ID.
function updateSamlConnection(
samlConnectionId: string,
params: UpdateSamlConnectionParams = {},
): Promise<Organization>
UpdateSamlConnectionParamsThe name to use as a label for this SAML Connection.
provider?'saml_custom' | 'saml_okta' | 'saml_google' | 'saml_microsoft'The IdP provider of the connection.
domain?stringThe domain of your organization. Sign in flows using an email with this domain will use this SAML Connection. For example: 'clerk.dev'
organizationId?stringThe ID of the organization to which users of this SAML Connection will be added
idpEntityId?stringThe Entity ID as provided by the IdP.
idpSsoUrl?stringThe Single-Sign On URL as provided by the IdP.
idpCertificate?stringThe X.509 certificate as provided by the IdP.
idpMetadataUrl?stringThe URL which serves the IdP metadata. If present, it takes priority over the corresponding individual properties.
idpMetadata?stringThe XML content of the IdP metadata file. If present, it takes priority over the corresponding individual properties.
attributeMapping?{ emailAddress?: string, firstName?: string, lastName?: string, userId?: string }The attribute mapping for the SAML connection.
active?booleanIndicates whether the connection is active or not.
syncUserAttributes?booleanIndicates whether the connection syncs user attributes between the Service Provider (SP) and Identity Provider (IdP) or not.
allowSubdomains?booleanIndicates whether users with an email address subdomain are allowed to use this connection in order to authenticate or not.
allowIdpInitiated?booleanIndicates whether the connection allows Identity Provider (IdP) initiated flows or not. </Properties>
const samlConnectionId = 'samlc_123'
const response = await clerkClient.samlConnections.updateSamlConnection(samlConnectionId, {
name: 'Updated SAML Connection',
})
This method in the SDK is a wrapper around the BAPI endpoint PATCH/saml_connections/{saml_connection_id}. See the BAPI reference{{ target: '_blank' }} for more information.
ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā
āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā