Skip to main content
import { useEffect, useState } from 'react';
import { useStytchB2BClient } from '@stytch/react/b2b';

export const GetSCIMGroups = () => {
  const stytch = useStytchB2BClient();
  const [groups, setGroups] = useState([]);

  const fetchGroups = async () => {
    const response = await stytch.scim.getConnectionGroups({
      connection_id: 'scim-connection-test-d6a0eaa4-ebf3-4982-bd1f-217f8a04a233',
    });
    setGroups(response.groups);
  };

  useEffect(() => {
    fetchGroups();
  }, []);

  return (
    <div>
      <h3>SCIM Groups</h3>
      {groups.map((group) => (
        <div key={group.group_id}>
          <p>{group.group_name}</p>
        </div>
      ))}
    </div>
  );
};
scim.getConnectionGroups wraps the Get SCIM Connection API endpoint. The organization_id will be automatically inferred from the logged-in .
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

limit
number
The number of search results to return per page. The default limit is 100. A maximum of 1000 results can be returned by a single search request. If the total size of your result set is greater than one page size, you must paginate the response. See the cursor field.
cursor
string
The cursor field allows you to paginate through your results. Each result array is limited to 1000 results. If your query returns more than 1000 results, you will need to paginate the responses using the cursor. If you receive a response that includes a non-null next_cursor in the results_metadata object, repeat the search call with the next_cursor value set to the cursor field to retrieve the next page of results. Continue to make search calls until the next_cursor in the response is null.

Response

connection
object
The SCIM Connection object belonging to the organization.
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.