Update External Connection

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

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

  const updateConnection = async () => {
    const response = await stytch.sso.external.updateConnection({
      connection_id: 'external-connection-test-d89ff7a0-e86f-4b4d-b6a3-9a74d967528e',
      display_name: 'Updated External Connection',
    });
    console.log('Updated connection:', response.connection);
  };

  return <button onClick={updateConnection}>Update External Connection</button>;
};

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

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

  const updateConnection = async () => {
    const response = await stytch.sso.external.updateConnection({
      connection_id: 'external-connection-test-d89ff7a0-e86f-4b4d-b6a3-9a74d967528e',
      display_name: 'Updated External Connection',
    });
    console.log('Updated connection:', response.connection);
  };

  return <button onClick={updateConnection}>Update External Connection</button>;
};

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

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

  const updateConnection = async () => {
    const response = await stytch.sso.external.updateConnection({
      connection_id: 'external-connection-test-d89ff7a0-e86f-4b4d-b6a3-9a74d967528e',
      display_name: 'Updated External Connection',
    });
    console.log('Updated connection:', response.connection);
  };

  return <button onClick={updateConnection}>Update External Connection</button>;
};

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

connection_id

string

required

Globally unique UUID that identifies a specific External SSO Connection.

display_name

string

required

A human-readable display name for the connection.

external_connection_implicit_role_assignments

array

required

All Members who log in with this External connection will implicitly receive the specified Roles. See the RBAC guide for more information about role assignment. Implicit role assignments are not supported for External connections if the underlying SSO connection is an OIDC connection.

Show properties

role_id

string

required

The unique identifier of the RBAC Role, provided by the developer and intended to be human-readable.

external_group_implicit_role_assignments

array

required

Defines the names of the groups that grant specific role assignments. For each group-Role pair, if a Member logs in with this external connection and belongs to the specified group, they will be granted the associated Role. See the RBAC guide for more information about role assignment. Before adding any group implicit role assignments to an external connection, you must add a “groups” key to the underlying SAML connection’s attribute_mapping. Make sure that the SAML connection IdP is configured to correctly send the group information. Implicit role assignments are not supported for External connections if the underlying SSO connection is an OIDC connection.

Show properties

group

string

required

The name of the group that grants the specified role assignment.

role_id

string

required

The unique identifier of the RBAC Role, provided by the developer and intended to be human-readable.

Response

connection

object

The External 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