Update SCIM Connection

Updates an existing SCIM connection. This method wraps the update-connection endpoint. 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. For all other fields, the caller must have the update permission on the stytch.scim resource. SCIM via the project's RBAC policy & their role assignments.

Method parameters

connection_id* string

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[objects]

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

group_id string

The ID of the group.

role_id string

The ID of the role.

Response fields

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 int

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.

connection object

A SCIM Connection connection belonging to the organization (currently limited to one).

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

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

  const updateSCIMConnection = () => {
    stytch.scim.updateConnection({
      connection_id: 'scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc',
      display_name: 'Updated SCIM connection name',
    });
  };

  return <button onClick={updateSCIMConnection}>Update SCIM Connection</button>;
};
RESPONSE 200
{
	"request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
	"status_code": 200,
    "connection": {
        "organization_id": "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931"
        "connection_id": "scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc"
        "status": "active",
        "display_name": "My SCIM Connection"
        "identity_provider": "okta"
        "base_url": "https://test.stytch.com/v1/b2b/scim/scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc"
        "bearer_token_last_four": "sdko"
        "bearer_token_expires_at": "2029-03-20T21:28:28Z"
    },
}
RESPONSE 401
{
  "status_code": 401,
  "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
  "error_type": "unauthorized_credentials",
  "error_message": "Unauthorized credentials.",
  "error_url": "https://stytch.com/docs/api/errors/401"
}
RESPONSE 403
{
  "status_code": 403,
  "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
  "error_type": "session_authorization_error",
  "error_message": "The Member is not authorized to perform the requested action on that resource.",
  "error_url": "https://stytch.com/docs/api/errors/403"
}
RESPONSE 429
{
  "status_code": 429,
  "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
  "error_type": "too_many_requests",
  "error_message": "Too many requests have been made.",
  "error_url": "https://stytch.com/docs/api/errors/429"
}
RESPONSE 500
{
  "status_code": 500,
  "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
  "error_type": "internal_server_error",
  "error_message": "Oops, something seems to have gone wrong, please reach out to support@stytch.com to let us know what went wrong.",
  "error_url": "https://stytch.com/docs/api/errors/500"
}