Update SAML Connection by Metadata URL

import { useStytchB2BClient } from '@stytch/react/b2b';

export const UpdateSAMLConnectionByURL = () => {
  const stytch = useStytchB2BClient();

  const updateConnection = async () => {
    const response = await stytch.sso.saml.updateConnectionByURL({
      connection_id: 'saml-connection-test-d89ff7a0-e86f-4b4d-b6a3-9a74d967528e',
      metadata_url: 'https://idp.example.com/metadata.xml',
    });
    console.log('Updated connection:', response.connection);
  };

  return <button onClick={updateConnection}>Update SAML Connection by URL</button>;
};

import { useStytchB2BClient } from '@stytch/react/b2b';

export const UpdateSAMLConnectionByURL = () => {
  const stytch = useStytchB2BClient();

  const updateConnection = async () => {
    const response = await stytch.sso.saml.updateConnectionByURL({
      connection_id: 'saml-connection-test-d89ff7a0-e86f-4b4d-b6a3-9a74d967528e',
      metadata_url: 'https://idp.example.com/metadata.xml',
    });
    console.log('Updated connection:', response.connection);
  };

  return <button onClick={updateConnection}>Update SAML Connection by URL</button>;
};

import { useStytchB2BClient } from '@stytch/react/b2b';

export const UpdateSAMLConnectionByURL = () => {
  const stytch = useStytchB2BClient();

  const updateConnection = async () => {
    const response = await stytch.sso.saml.updateConnectionByURL({
      connection_id: 'saml-connection-test-d89ff7a0-e86f-4b4d-b6a3-9a74d967528e',
      metadata_url: 'https://idp.example.com/metadata.xml',
    });
    console.log('Updated connection:', response.connection);
  };

  return <button onClick={updateConnection}>Update SAML Connection by URL</button>;
};

sso.saml.updateConnectionByURL wraps the Update SAML Connection by Metadata URL API endpoint. The organization_id will be automatically inferred from the logged-in session. This method cannot be used to update SAML connections in other .

RBAC Enforced MethodThis method requires a valid Session for a member with permission to perform the Action on the Resource.Before using this method, enable Member actions & organization modifications in the Frontend SDK page. To learn more, see our RBAC guide.

Parameters

connection_id

string

required

Globally unique UUID that identifies a specific SSO connection_id for a Member.

metadata_url

string

required

A URL that points to the IdP metadata. This will be provided by the IdP.

Response

connection

object

The SAML Connection object updated by this API call.

request_id

string

Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.

status_code

number

The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.

⌘I

​Parameters

​Response

Parameters

Response