Delete Encryption Private Key

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

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

  const deletePrivateKey = async () => {
    const response = await stytch.sso.saml.deleteEncryptionPrivateKey({
      connection_id: 'saml-connection-test-d89ff7a0-e86f-4b4d-b6a3-9a74d967528e',
      private_key_id: 'private-key-test-28f29eef-400f-4343-a83f-baf3eeba28c5',
    });
    console.log('Deleted private key:', response.private_key_id);
  };

  return <button onClick={deletePrivateKey}>Delete Private Key</button>;
};

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

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

  const deletePrivateKey = async () => {
    const response = await stytch.sso.saml.deleteEncryptionPrivateKey({
      connection_id: 'saml-connection-test-d89ff7a0-e86f-4b4d-b6a3-9a74d967528e',
      private_key_id: 'private-key-test-28f29eef-400f-4343-a83f-baf3eeba28c5',
    });
    console.log('Deleted private key:', response.private_key_id);
  };

  return <button onClick={deletePrivateKey}>Delete Private Key</button>;
};

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

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

  const deletePrivateKey = async () => {
    const response = await stytch.sso.saml.deleteEncryptionPrivateKey({
      connection_id: 'saml-connection-test-d89ff7a0-e86f-4b4d-b6a3-9a74d967528e',
      private_key_id: 'private-key-test-28f29eef-400f-4343-a83f-baf3eeba28c5',
    });
    console.log('Deleted private key:', response.private_key_id);
  };

  return <button onClick={deletePrivateKey}>Delete Private Key</button>;
};

sso.saml.deleteEncryptionPrivateKey wraps the Delete Encryption Private Key API endpoint. The organization_id will be automatically inferred from the logged-in session. This method cannot be used to delete encryption private keys in other . You may need to do this when rotating encryption private keys from your IdP, since Stytch allows a maximum of 5 private keys per connection.

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 SSO connection_id for a Member.

private_key_id

string

required

The ID of the encryption private key to be deleted.

Response

private_key_id

string

The private_key_id that was deleted as part of the delete request.

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