Create External Connection

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

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

  const createConnection = async () => {
    const response = await stytch.sso.external.createConnection({
      display_name: 'External Org Connection',
      external_organization_id: 'organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931',
      external_connection_id: 'saml-connection-test-d89ff7a0-e86f-4b4d-b6a3-9a74d967528e',
    });
    console.log('Created connection:', response.connection);
  };

  return <button onClick={createConnection}>Create External Connection</button>;
};

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

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

  const createConnection = async () => {
    const response = await stytch.sso.external.createConnection({
      display_name: 'External Org Connection',
      external_organization_id: 'organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931',
      external_connection_id: 'saml-connection-test-d89ff7a0-e86f-4b4d-b6a3-9a74d967528e',
    });
    console.log('Created connection:', response.connection);
  };

  return <button onClick={createConnection}>Create External Connection</button>;
};

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

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

  const createConnection = async () => {
    const response = await stytch.sso.external.createConnection({
      display_name: 'External Org Connection',
      external_organization_id: 'organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931',
      external_connection_id: 'saml-connection-test-d89ff7a0-e86f-4b4d-b6a3-9a74d967528e',
    });
    console.log('Created connection:', response.connection);
  };

  return <button onClick={createConnection}>Create External Connection</button>;
};

sso.external.createConnection wraps the Create External Connection API endpoint. The organization_id will be automatically inferred from the logged-in session. This method cannot be used to create External 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

display_name

string

A human-readable display name for the connection.

external_organization_id

string

required

Globally unique UUID that identifies a different Organization within your Project.

external_connection_id

string

required

Globally unique UUID that identifies a specific SSO connection configured for a different Organization in your Project.

Response

connection

object

The External Connection object created 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