Update SCIM Connection

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

export const UpdateSCIMConnection = () => {
  const stytch = useStytchB2BClient();
  const [displayName, setDisplayName] = useState('');

  const updateConnection = async () => {
    const response = await stytch.scim.updateConnection({
      connection_id: 'scim-connection-test-d6a0eaa4-ebf3-4982-bd1f-217f8a04a233',
      display_name: displayName,
    });
    console.log('SCIM connection updated:', response);
  };

  return (
    <div>
      <input
        type="text"
        value={displayName}
        onChange={(e) => setDisplayName(e.target.value)}
        placeholder="New display name"
      />
      <button onClick={updateConnection}>Update Connection</button>
    </div>
  );
};

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

export const UpdateSCIMConnection = () => {
  const stytch = useStytchB2BClient();
  const [displayName, setDisplayName] = useState('');

  const updateConnection = async () => {
    const response = await stytch.scim.updateConnection({
      connection_id: 'scim-connection-test-d6a0eaa4-ebf3-4982-bd1f-217f8a04a233',
      display_name: displayName,
    });
    console.log('SCIM connection updated:', response);
  };

  return (
    <div>
      <input
        type="text"
        value={displayName}
        onChange={(e) => setDisplayName(e.target.value)}
        placeholder="New display name"
      />
      <button onClick={updateConnection}>Update Connection</button>
    </div>
  );
};

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

export const UpdateSCIMConnection = () => {
  const stytch = useStytchB2BClient();
  const [displayName, setDisplayName] = useState('');

  const updateConnection = async () => {
    const response = await stytch.scim.updateConnection({
      connection_id: 'scim-connection-test-d6a0eaa4-ebf3-4982-bd1f-217f8a04a233',
      display_name: displayName,
    });
    console.log('SCIM connection updated:', response);
  };

  return (
    <div>
      <input
        type="text"
        value={displayName}
        onChange={(e) => setDisplayName(e.target.value)}
        placeholder="New display name"
      />
      <button onClick={updateConnection}>Update Connection</button>
    </div>
  );
};

scim.updateConnection wraps the Update SCIM Connection API endpoint.

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

The ID of the SCIM connection.

identity_provider

string

Name of the IdP. Enum with possible values: classlink, cyberark, duo, google-workspace, jumpcloud, keycloak, miniorange, microsoft-entra, okta, onelogin, pingfederate, rippling, salesforce, shibboleth, or generic.Specifying a known provider allows Stytch to handle any provider-specific logic.

display_name

string

A human-readable display name for the connection.

scim_group_implicit_role_assignments

array

required

An array of SCIM group implicit role assignments. Each object in the array must contain a group_id and a role_id.

Show properties

group_id

string

required

The ID of the group.

role_id

string

required

The ID of the role.

If attempting to modify the scim_group_implicit_role_assignments the caller must have the update.settings.implicit-roles permission on the stytch.organization resource.

Response

connection

object

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